{"id":28353743,"url":"https://github.com/tanikai/uniulm_mensa_api","last_synced_at":"2025-07-06T23:04:52.202Z","repository":{"id":171847976,"uuid":"561883974","full_name":"Tanikai/uniulm_mensa_api","owner":"Tanikai","description":"REST API for Canteen / Mensa plans at Ulm University","archived":false,"fork":false,"pushed_at":"2025-05-05T14:06:58.000Z","size":49,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-22T00:37:27.257Z","etag":null,"topics":["canteen","mensa","rest-api","uulm"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tanikai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-11-04T17:58:06.000Z","updated_at":"2025-05-05T14:07:02.000Z","dependencies_parsed_at":"2023-12-20T19:43:47.889Z","dependency_job_id":"adcef5a4-1321-48f7-bd98-29e6d32d63a7","html_url":"https://github.com/Tanikai/uniulm_mensa_api","commit_stats":null,"previous_names":["tanikai/uniulm_mensa_api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Tanikai/uniulm_mensa_api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tanikai%2Funiulm_mensa_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tanikai%2Funiulm_mensa_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tanikai%2Funiulm_mensa_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tanikai%2Funiulm_mensa_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tanikai","download_url":"https://codeload.github.com/Tanikai/uniulm_mensa_api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tanikai%2Funiulm_mensa_api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263986227,"owners_count":23539808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["canteen","mensa","rest-api","uulm"],"created_at":"2025-05-28T01:38:13.867Z","updated_at":"2025-07-06T23:04:52.196Z","avatar_url":"https://github.com/Tanikai.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Uni Ulm Mensa Plan REST API\n\nThis project contains a REST API that provides data from the\n[Tanikai/uniulm_mensaparser](https://github.com/Tanikai/uniulm_mensaparser)\nmodule.\n\nThe parsed data can be accessed here:\n[uulm.anter.dev/api/v1/canteens/all](https://uulm.anter.dev/api/v1/canteens/all)\n\n## Getting Started\n\nThese instructions will give you a copy of the project up and running on\nyour local machine for development and testing purposes. See deployment\nfor notes on deploying the project on a live system.\n\n### Prerequisites\n\nThis project is tested and deployed with Python 3.9+. It might work with lower\nversions, but without guarantee.\n\n### Installing\n\nFirstly, clone this repository and install the required Python modules:\n\n```sh\ngit clone https://github.com/Tanikai/uniulm_mensa_api.git\ncd uniulm_mensa_api\npip install -r requirements.txt\n```\n\nAfter that, you can run the REST API with:\n\n```sh\nuvicorn app.main:app --reload\n```\n\n## Deployment\n\nWhen you want to deploy the application, you will need a WSGI server. For\nexample, you can use the [waitress](https://github.com/Pylons/waitress) module:\n\n```sh\nuvicorn app.main:app --reload\n```\n\n## API Documentation\n\nThe following canteens at Ulm University are currently supported:\n\n- Mensa Süd (id: **ul_uni_sued**)\n- Mensa West (id: **ul_uni_west**)\n\nSupport for Mensa Nord (Bistro) is planned.\n\n| Path                                                        | Description                                                                                      |\n|-------------------------------------------------------------|--------------------------------------------------------------------------------------------------|\n| `BASE_URL/api/v1/canteens/CANTEEN_ID/`                      | Get the next daily plan for the specified canteen (days where the canteen is closed are skipped) |\n| `BASE_URL/api/v1/canteens/CANTEEN_ID/days/YYYY-MM-DD/meals` | Get the canteen plan for a specific day                                                          |\n| `BASE_URL/api/v1/canteens/CANTEEN_ID/all`                   | Get all plans for the specified canteen                                                          |\n| `BASE_URL/api/v1/mensaplan.json`                            | Data in [FS-ET format](https://mensaplan.fs-et.de/data/mensaplan.json) (work in progess)         |\n\n\n## Analytics\n\nTo track the API usage in a GDPR-friendly way, a Middleware\nfor [Matomo](https://matomo.org/) is integrated into the project. Alternatively,\nyou can use [Umami](https://umami.is/). Both are disabled by default.\n\nTo enable analytics, set the respective `_ENABLED` variable to `True` and pass\nthe required configuration values:\n\n```sh\n# Matomo\nMATOMO_ENABLED=True\nMATOMO_URL=YOUR_MATOMO_URL\nMATOMO_SITE_ID=YOUR_MATOMO_SITE_ID\n\n# Umami\nUMAMI_ENABLED=True\nUMAMI_URL=YOUR_UMAMI_URL\nUMAMI_SITE_ID=YOUR_UMAMI_SITE_ID\n```\n\n## Authors\n\n- **Kai Anter** - [GitHub](https://github.com/Tanikai) - [Mastodon](https://hachyderm.io/@tanikai)\n\n## License\n\nThis project is licensed under the GNU General Public License Version 3 - see\nthe [LICENSE](LICENSE) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftanikai%2Funiulm_mensa_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftanikai%2Funiulm_mensa_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftanikai%2Funiulm_mensa_api/lists"}