OpenTamPy - A Python library to interface with https://intranet.tam.ch/


License
GPL-3.0
Install
pip install OpenTamPy==0.10.1

Documentation

OpenTamPy

Documentation Status build

A Python Library to simplify the access to the Intranet website

Full Documentation

Example snippet, more can be found in the documentation as well as in examples/

from OpenTamPy import Intranet

    username = "YOURUSERNAME"
    password = "YOURPASSWORD"
    school = "krm"

    instance = Intranet(username, password, school)
    timetable = instance.get_timetable()
    for lesson in timetable:
        print(lesson.courseName)

Development

Installing with pip

python3 -m pip install OpenTamPy

Installing from source

  1. Clone the repo from https://github.com/neonfighter28/OpenTamPy
  2. Install dependencies from requirements.txt with pip install -r requirements.txt

Check typehints and pep8

Please make sure your PR is pep8 compliant. More about pep8 can be found here

  1. Make sure you have mypy and pycodestyle installed
  2. run mypy ./src/OpenTamPy.py
  3. run pycodestyle OpenTamPy.py --max-line-length=119

Pushing to GitHub

  1. Fork the project
  2. Commit your changes
  3. Create a Pull Request