diff --git a/README.md b/README.md new file mode 100644 index 0000000..315ded8 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Ausweisstatus + +A small application to check the status of IDs like _Personalausweis_ and _Reisepass_ on https://ausweisstatus.regioit.de/aachen automatically and send notifications on changes. + +Tested with the status page for Aachen but _should_ work for other cities using _regioit.de_ + +## Why? +I wanted to know when my _Personalausweis_ was ready for collection without manually checking the page periodically. + +## Usage + +### With Docker +A `Dockerfile` is provided containing everything necessary to send notifications on status changes. + +Before building the Docker image, adjust the `WEBHOOK_URL` (see [here](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) for creation instructions), _Passauswahl_ (_P_, _R_, or _ID_, see below), _Seriennummer_ and _Geburtsdatum_ in the `crontab` file. + +Then, build and start the container with `docker compose up -d --build` on a machine with high availability. +You will now be notified when the status of your document is changed. + +### Without Docker +First, install the dependencies, I recommend using [`uv`](https://docs.astral.sh/uv/): +```bash +uv venv +source .venv/bin/activate +uv pip install -r requirements.txt +``` +The provided script `ausweisstatus.py` can be used to retrieve the current status of your document. + +``` +./ausweisstatus.py