This repository is a collection of Azure Functions that expose the features of fristenkalender_generator. It's used by the fristenkalender-frontend which is deployed to fristenkalender.hochfrequenz.de.
| HTTP Method | Function Name | Purpose | Parameter | Response | localhost example | online example |
|---|---|---|---|---|---|---|
| GET | GenerateAllFristen |
generates all fristen for a given year | a year (a number, e.g. 2023) | a JSON list, use &concise=True for compact output |
test with localhost:7071 | test with fristenkalender.azurewebsites.net |
| GET | GenerateAndExportWholeCalendar |
generates an ics-file for a given year, with a given filename and a given attendee | a year (a number, e.g. 2023), a file_name, and an email address | an ics-file | test with localhost:7071 | test with fristenkalender.azurewebsites.net |
| GET | GenerateFristenForType |
generates fristen for a given type and a given year | a year (a number, e.g. 2023) and a fristen type | a JSON list | test with localhost:7071 | test with fristenkalender.azurewebsites.net |
| GET | GenerateAndExportFristenForType |
generates an ics-file for a given year, with a given filename, attendee and type of a frist | a year (a number, e.g. 2023), a file_name, an email address and a type of a frist | an ics-file | test with localhost:7071 | test with fristenkalender.azurewebsites.net |
The functions in this repository should contain only actual logic for providing a HTTP interface to existing FristenkalenderGenerator functionality .
You need to take two steps to get this repository running on your localhost:
- install and setup the Azure Function framework
- setup the Python virtual env
Please follow the official documentation on Python based Azure Functions for guidance on how Azure Function projects are structured and how to setup your local development environment.
For the Python part alone, just follow the usual tox workflow.
Once you completed the general Azure Function setup, go into the src directory and run
func startAs of 2023-09-15 Azure Function only supports also support Python 3.11 (preview).
In case your local tox base uses Python v3.10 (and you cloned this repo before 2022-04-04), you'll run into an error if you try to start the Azure Function (the plain Python unit tests will behave normally, though):
Found Python version 3.10.0 (py). Python 3.6.x to 3.9.x is required for this operation. Please install Python 3.6, 3.7, 3.8, or 3.9 and use a virtual environment to switch to Python 3.6, 3.7, 3.8, or 3.9.
To pin tox to Python v3.9 we use the tox' basepython setting.
Re-create the dev environment, then try again.
On any push to main, the functions from above are deployed
to fristenkalender.azure-websites.net.
The respective workflow file was autogenerated by the Azure Portal and manually modified such that we copy the content of src to the repo root first.
The resource group name in Azure is "fristenkalender",
too.