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.1.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: muni-is-api-0.8.1.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.1.tar.gz
Algorithm Hash digest
SHA256 8da72b73da1bafe476c0b7b7a3bc5bf322b60668e5143f9bd4bbc575e33b79a2
MD5 7d9c5dbbf51a8a66819d501144a07bd8
BLAKE2b-256 76f6bfaa15b0c8c085d6eee6611566571fa3afb388262e7e93ed8b9ae6a8fa6c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muni_is_api-0.8.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 003c642a5b99d7413e8fb04a1def09ea8f029342f753a362f29db08905edff9a
MD5 b75f30404d454beddd648167ee403aca
BLAKE2b-256 5a0be8d6527677a5cee19ebb0b388ae390b11b18ac144aa38614e49ebbca56ff

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