This is an API to access to the databases of the German Federal Employment Agency (Deutsche Bundesagentur für Arbeit).
This repository is built on Python 3.12. In best case, create a virtual environment with the following command.
python -m venv venv
Activate the environment and install the required packages using:
pip install -r requirements.txt
The API is built using FastAPI. The code is structured following the best practices.
To start the API, please run:
python -m scripts.main
To make the server restart after code changes, please run (only for development):
python -m scripts.main --reload
Since one benefit of this project is the ability to work with local data, it is important to easily fetch applicant profiles to store them locally. For this purpose, you can use the script scripts/search_and_fetch_details.py. One potential use is
python -m scripts.search_and_fetch_details --max_graduation_year 2000 --location_keyword "München" --pages_count 10 --skip-existing
To test the application, please run the command:
python -m unittest discover tests