Skip to main content

Tool for fetching University of Oulu restaurant menus from Jamix.

Project description

jmenu

Command line tool for fetching University of Oulu restaurant menus from the Jamix API.

Doubles as a general library for fetching menu info from Jamix.

Installing

Python Package Index

jmenu is available for install on the python package index.

pip install jmenu

Building from source

For testing purposes, the package can be built from the repository source code.

pip install build
python3 -m build
pip install dist/<package_name>.whl

Usage

Command line tool

jmenu can be invoked from the command line as is:

jmenu [-h] [-v] [-e] [-t] [-l {fi,en}] [-a markers [G, VEG ...]]

All flags and parameters described below

Argument Example Description
-a, --allergens g veg Highlights appropriately marked results
Flag Description
-h, --help Display usage information
-v, --version Display version information
-e, --explain Display allergen marker information
-t, --tomorrow Fetch menu results for tomorrow
-l, --language Result language, opts: {fi, en}

Python library

jmenu can also be imported as a library:

from jmenu import main

main.run()

Documentation for the library can be found in the project pages.

Contributing

Pull requests are welcome. We use pre-commit hooks and GitHub actions to ensure code quality.

Development environment setup

Requirements

  • Python 3.10+
  • Virtualenv

Setup the development environment with

python3 -m virtualenv env
source env/bin/activate
pip install -r requirements.txt

Testing

Run the tool

python3 -m src.jmenu.main

Execute unit tests

pytest

Documentation

Documentation for the project is available in the project pages.

Build documentation from source

The documentation for the modules is built with Mkdocs. and the mkdocstrings extension, using google style docstrings.

You can build it from source by installing mkdocs

pip install mkdocs mkdocs-material
mkdocs serve

and navigating to localhost:8000 in your browser.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jmenu-1.9.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

jmenu-1.9.0-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file jmenu-1.9.0.tar.gz.

File metadata

  • Download URL: jmenu-1.9.0.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for jmenu-1.9.0.tar.gz
Algorithm Hash digest
SHA256 f7c9a8390a5db15b3dae485c52ae8c279ef7f7105ad99d90938a85e50819fbf7
MD5 06d06160dd7278f8cce2aa1d1ebad15f
BLAKE2b-256 bd00dd417079310349d85c0dc61ca0a380feca200611a85afa8579431e0d4bf1

See more details on using hashes here.

File details

Details for the file jmenu-1.9.0-py3-none-any.whl.

File metadata

  • Download URL: jmenu-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for jmenu-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0bce562b00bfe82be1e4bfc47ecb7059b7e1be80af94f0ec39c7da3c25e85dce
MD5 2041495c1914d0699be21b55effe9a54
BLAKE2b-256 9e4315bb53e1fa924f3c02e0148481d312ca82ea34262e7f6c73e4e11f5a6d74

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page