uniulm-mensaparser 1.0.1

A parser for the canteen / Mensa plans at Ulm University

Uni Ulm Mensa Parser

This project contains a parser for the canteen / Mensa plans at Ulm University that are provided on the Studierendenwerk Ulm website. You can see the data in action on the UUlm Mensaplan website.

For an example of parsed data, see the following REST API endpoint: https://uulm.anter.dev/api/v1/canteens/all

Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

This project is tested and deployed with Python 3.9+. The dependencies require Python 3.8+.

Integration into your own project

You can install the module from PyPI:

pip install uniulm-mensaparser

After installing, you can use the parser like this:

from uniulm_mensaparser import get_plan, Canteen, SimpleAdapter2

# use get_plan() to get plans of all supported canteens
plan = get_plan()
print(plan)

# specify which canteen plans you want to be parsed in a set
my_canteens = {Canteen.UL_UNI_Sued}
# pass an adapter class for a different output format
plan = get_plan(my_canteens, adapter_class=SimpleAdapter2)
print(plan)

Development

Installation

If you want to extend the functionality of this library (e.g. implementing a new Adapter or PDF parser), you can clone this repository and install the required Python modules:

git clone https://github.com/Tanikai/uniulm_mensaparser.git
cd uniulm_mensaparser
uv sync

Tooling

This project uses uv for dependency management, ruff for linting and formatting, and ty for type checking.

To format and lint the code, run:

uvx ruff format .
uvx ruff check . --fix

To run the type checks:

uv run ty check

To run the tests:

uv run pytest

MaxManager API endpoint

The following curl command sends a request to the new endpoint. Remember to replace the date with the current date.

curl -X POST 'https://sw-ulm-spl51.maxmanager.xyz/inc/ajax-php_konnektor.inc.php?func=make_spl&locId=1&date=2023-07-20&lang=de&startThisWeek=2023-07-17&startNextWeek=2023-07-24'

Built With

• BeautifulSoup to parse the canteen plan from the Studierendenwerk Ulm website
• aiohttp for asynchronous HTTP requests

Authors

• Kai Anter: GitHub, Mastodon

License

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