Skip to main content

Python wrapper for the IS MUNI API

Project description

IS MUNI API python wrapper

Python wrapper for the IS MUNI API. The IS MUNI Notes API documentation can be found here.

The output format

Getting Started

Build status CircleCI

Prerequisites

  • requires Python 3.6 or higher

Install

pip install muni-is-api
poetry add https://github.com/pestanko/py-is-muni-api.git

Example

Example usage of the IS API client

import muni_is_api

client = muni_is_api.IsApiClient(
        domain='is.muni.cz',
        token='secret_token',
        faculty_id=1000,
        course_code='PB000'
    )

# Get na course info
course_info = client.course_info()

# Get list of students in the course
students = client.course_list_students(registered=False, terminated=False, inactive=False)

# Get list of stundets in the provided seminary
sem_stud = client.seminar_list_students(seminars=['01', '02'], terminated=False, inactive=False)

# Get list of teachers for the provided seminary
sem_teach = client.seminar_list_teachers(seminars=['01', '02'])

# Get list of all notepads for the course
notepads = client.notepad_list()

# Get notepad content for the specified notepad shortcut and ucos
notepad_content = client.notepad_content(shortcut='hw01', ucos=[1000, 1234, 12345])

# Create a new notepad
client.notepad_new(name="Homework 01", shortcut="hw01", visible=True, complete=False, statistics=True)

# Update a notepad
client.notepad_update(shortcut="hw01", uco=1000, content="Great work! *2", override=True)

# List all exams
exams = client.exams_list(terminated=False, inactive=False)

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

muni-is-api-0.8.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

muni_is_api-0.8.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file muni-is-api-0.8.0.tar.gz.

File metadata

  • Download URL: muni-is-api-0.8.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.5 Linux/5.3.16-300.fc31.x86_64

File hashes

Hashes for muni-is-api-0.8.0.tar.gz
Algorithm Hash digest
SHA256 dec0e887a018a0b121a89010b2ba2e6cf457520ee45c63416e0b2ccbde6b9a4a
MD5 acee6e541beb7cce751b8fd3e83822fc
BLAKE2b-256 dde1b736ba4697b48f4d86340d8079edc2791fc8435743e84de4d06f99029605

See more details on using hashes here.

File details

Details for the file muni_is_api-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: muni_is_api-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.5 Linux/5.3.16-300.fc31.x86_64

File hashes

Hashes for muni_is_api-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79a276b6670f5e5c631269b4d34e3134f1ba33e9958397ec4b0f6b8ed5679ca8
MD5 1b09c844af48386b8731a4e63b20fd86
BLAKE2b-256 8ebe6bc254e78e0663d3bedb6e16a3d0aebf78067661c7253e8d269c8d17caa3

See more details on using hashes here.

Supported by

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