Steuerlotse Erica service

??
Erica is a service to send tax declarations to ELSTER.
It is a wrapper around the functionality of EriC, ELSTER’s own client to access their APIs.
It provides functionality to send tax declarations, as well as request, activate and revoke unlock codes.

It was originally developed as part of the Tech4Germany Fellowship 2020.
The fellowship is organized by DigitalService4Germany GmbH.

??
Erica ist ein Service um Steuererklärungen an ELSTER zu senden.
Es dient als Wrapper um die Funktionalität von EriC, ELSTERs eigener Client um die APIs zu verwenden.
Es stellt Funktionalität zum Absenden von Steuererklärungen sowie dem Beantragen, Freischalten und Stornieren von Freischaltcodes bereit.

Ursprünglich wurde es als Teil des Tech4Germany Fellowships 2020 entwickelt,
das von der DigitalService4Germany GmbH organisiert wird.

Contributing

??
Everyone is welcome to contribute the development of the Steuerlotse. You can contribute by opening pull request,
providing documentation or answering questions or giving feedback. Please always follow the guidelines and our
Code of Conduct.

??
Jede:r ist herzlich eingeladen, die Entwicklung der Steuerlotse mitzugestalten. Du kannst einen Beitrag leisten,
indem du Pull-Requests eröffnest, die Dokumentation erweiterst, Fragen beantwortest oder Feedback gibst.
Bitte befolge immer die Richtlinien und unseren Verhaltenskodex.

Contributing code

??
Open a pull request with your changes and it will be reviewed by someone from the team. When you submit a pull request,
you declare that you have the right to license your contribution to the DigitalService4Germany and the community.
By submitting the patch, you agree that your contributions are licensed under the MIT license.

Please make sure that your changes have been tested befor submitting a pull request.

??
Nach dem Erstellen eines Pull Requests wird dieser von einer Person aus dem Team überprüft. Wenn du einen Pull-Request
einreichst, erklärst du dich damit einverstanden, deinen Beitrag an den DigitalService4Germany und die Community zu
lizenzieren. Durch das Einreichen des Patches erklärst du dich damit einverstanden, dass deine Beiträge unter der
MIT-Lizenz lizenziert sind.

Bitte stelle sicher, dass deine Änderungen getestet wurden, bevor du einen Pull-Request sendest.

For Developers ?‍? ?‍?

Getting started ?

Install Python dependencies

pipenv install

Download ERiC

Erica uses Pyeric, which is a wrapper around ERiC. For this to work you will need to download the latest ERiC
library and place the required library files in a lib folder.

  • Set the environment variable ERICA_ENV to testing, development or similar.
  • Download ERiC-35.2.8.0-Linux-x86_64.jar (or a newer version) from the ELSTER developer portal.
  • Place the following files into a lib folder in this directory such that it matches the given structure:

pyeric$ tree lib
lib
├── libericapi.so
├── libericxerces.so
├── libeSigner.so
└── plugins2
    ├── libcheckElsterDatenabholung.so
    ├── libcheckESt_2021.so
    ├── libcheckVaSt.so
    └── libcommonData.so

NOTE: If you use a Mac, get the corresponding *.dylib files

Obtain Certificate

You also need to obtain a test certificate from ELSTER and place it under erica/instances/blueprint/cert.pfx.

Developing ?‍? ?‍?

export ERICA_ENV=development
python -m erica

Testing ?

You can run tests as follows:

pipenv run pytest

If you are missing the ERiC library or a suitable certificate then the respective
tests will be skipped.

GitHub

View Github