Skip to main content

Zermelo api wrapper library for python.

Project description

Zermelo.py

Zermelo api wrapper library for python.

Features

  1. Get appointments from your zermelo calender.
  2. Get your zermelo user data.
  3. Get the zermelo announcements from your school.

Installation

To install the package run this command:

  pip install zermelo.py

Usage

Client

Client()

params:

School: String ? Zermelo name of your school.

Result:

Client: Zermelo.Client()

Demo:

from zermelo import Client

cl = Client("scalacollege")

Authentication

Client.authenticate()

Params:

Code: String ? A connect code you get from https://YOURSCHOOLNAME.zportel.nl/main/#connectionsModule-connectApp

Result:

Token: dict()

Demo:

token = cl.auhtenticate("441 440 997 507")
print(token["access_token"])

User

Client.get_user()

Params:

Token: String ? Access_token you get from Client.Authenticate()

Result:

User: dict()

Demo:

user = cl.get_user(token["access_token"])
print(user)

Appointments

Client.get_appointments()

Params:

Token: String ? Access_token you get from Client.Authenticate()
StartUnix: int ? Unix timestamp for the first date you want to get the appointments from.
EndUnix: int ? Unix timestamp for the last date you want to get the appointments from.

Result:

Appointments: dict()

Demo:

appointments = cl.get_appointments(token["access_token"], 1567468800, 1568073600)
print(appointments)

Announcements

Client.get_announcements()

Params:

Token: String ? Access_token you get from Client.Authenticate()

Result:

Announcements: dict()

Demo:

announcements = cl.get_announcements(token["access_token"])
print(announcements)

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

zermelo.py-1.0.1.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

zermelo.py-1.0.1-py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 3

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