Skip to content

Tanikai/uniulm_mensa_api

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

Uni Ulm Mensa Plan REST API

This project contains a REST API that provides data from the Tanikai/uniulm_mensaparser module.

The parsed data can be accessed here: uulm.anter.dev/api/v1/canteens/ul_uni_sued

Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.

Prerequisites

This project is tested and deployed with Python 3.9+. It might work with lower versions, but without guarantee.

Installing

Firstly, clone this repository and install the required Python modules:

git clone https://github.com/Tanikai/uniulm_mensa_api.git
cd uniulm_mensa_api
pip install -r requirements.txt

After that, you can run the REST API with:

python run_api.py

Deployment

When you want to deploy the application, you will need a WSGI server. For example, you can use the waitress module:

python -m waitress --port 8080 run_api:application

API Documentation

The following canteens at Ulm University are currently supported:

  • Mensa Süd (id: ul_uni_sued)
  • Mensa West (id: ul_uni_west)
Path Description
BASE_URL/api/v1/canteens/CANTEEN_ID/ Get the next plan for the Mensa Süd (days where the canteen is closed are skipped)
BASE_URL/api/v1/canteens/CANTEEN_ID/days/YYYY-MM-DD/meals Get the mensa plan for a specific day

Analytics

To track the API usage in a GDPR-friendly way, a Python integration for Matomo is integrated into the project. It is only enabled when a config.ini file is placed in the root directory (same directory as run_api.py). If you want to connect the API to your Matomo instance, set the following properties:

[Matomo]
enabled = True 
; The URL to your Matomo instance
url = YOUR_MATOMO_URL
; Your Matomo site_id for the API (e.g. 5)
site_id = YOUR_MATOMO_SITE_ID 
; Visitor might be behind a proxy. To change the IP address of the 
; POST Request, an auth token is required. You can get it in Matomo
; under Settings > Personal > Security > Auth tokens.
token_auth = YOUR_API_TOKEN

Built With

Authors

License

This project is licensed under the GNU General Public License Version 3 - see the LICENSE.md file for details

About

REST API for Canteen / Mensa plans at Ulm University

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages