zermelo api
Project description
zermelo api v:2022.05.20.16.21.27
documentation
install
pip install zermeloapi
how to import
import zermeloapi
initializing
zermelo = zermeloapi.zermelo(school, username, password, teacher=False, version=3)
get token
token = zermelo.get_token()
if u wand to u can give the school username and password again but u don't need to in that case u can use get_token(school,username,password)
get access token
access_token = zermelo.get_access_token()
again if u wand to u can give the school and username again but u don't need to in that case u can use get_access_token(school,username)
get raw schedule
raw_schedule = zermelo.get_schedule()
u can give the week number and or year of u wand to else it uses the current year/week u can use get_schedule(week=20)
,get_schedule(year=2022)
orget_schedule(year=2022,week=20)
get schedule
raw_schedule = zermelo.get_schedule()
u can give the week number and or year of u wand to else it uses the current year/week u can use get_schedule(week=20)
,get_schedule(year=2022)
orget_schedule(year=2022,week=20)
and u you can pass a rawshedule from get_raw_shedule()
sort schedule
sorted_schedule = zermelo.sort_schedule()
like before u can give the week and year but u can also give the schedule from get_schedule()
instead to sort it defaults to getting it self but if u give it uses that one u can do that by using it like this sort_schedule(schedule)
for the week and year it is the same syntax
readable schedule
readable = zermelo.readable_schedule()
again u can give it week and year with the same syntax as before also you can give it a sorted schedule (output from sort_schedule()
) by using readable_schedule(sorted_schedule)
print schedule
zermelo.print_schedule()
yes u can use it like this zermelo.print_schedule(zermelo.readable_schedule())
but WHY if u wand that use it like that just print(zermelo.readable_schedule())
the only use is that it defaults to zermelo.readable_schedule()
source code
from asyncio.windows_events import NULL
import os.path
import requests
import json
import time
import base64
from datetime import datetime
class zermelo:
expires_in = 0
school = ''
username = ''
teacher = False
debug = False
TimeToAddToUtc = 0
def __init__(self, school, username,password=None, teacher=False, version=3,debug=False,linkcode=None):
self.school = school
self.username = username
self.teacher = teacher
self.debug = debug
self.version = 'v'+str(version)
self.TimeToAddToUtc = self.get_date()[2]
if linkcode == None and password != None:
self.token = self.get_tokenfromusrpsw(school=school,username=username,password=password)
else:
self.token = self.gettokenfromfile(linkcode=linkcode)
def updatetoken(self, linkcode):
self.token = self.gettokenfromfile(linkcode=linkcode)
def gettokenfromlinkcode(self, linkcode=None):
if linkcode == None:
linkcode = input("apitoken: ").replace(" ",'')
else:
linkcode = str(linkcode).replace(" ",'')
return json.loads(requests.post(f"https://ozhw.zportal.nl/api/v3/oauth/token?grant_type=authorization_code&code={linkcode}").text)["access_token"]
def get_tokenfromusrpsw(self, school=None, username=None, password=None):
if(school == None):
school = self.school
if (username == None):
username = self.username
if(password == None):
password = self.password
url = 'https://'+school+'.zportal.nl/api/'+self.version+'/oauth'
myobj = {'username': username, 'password': password, 'client_id': 'OAuthPage', 'redirect_uri': '/main/',
'scope': '', 'state': '4E252A', 'response_type': 'code', 'tenant': school}
x = requests.post(url, data=myobj)
respons = x.text
if self.debug:
print(x.text)
start = respons.find("code=") + len("code=")
end = respons.find("&", start)
token = respons[start:end]
start = respons.find("tenant=") + len("tenant=")
end = respons.find("&", start)
school = respons[start:end]
start = respons.find("expires_in=") + len("expires_in=")
end = respons.find("&", start)
self.expires_in = respons[start:end]
start = respons.find("loginMethod=") + len("loginMethod=")
end = respons.find("&", start)
self.loginMethod = respons[start:end]
start = respons.find("interfaceVersion=") + len("interfaceVersion=")
end = respons.find("&", start)
self.interfaceVersion = respons[start:end]
if(school == None):
school = self.school
if(token == None):
token = self.get_token()
url = 'https://' + school+'.zportal.nl/api/'+self.version+'/oauth/token'
myobj = {'code': token, 'client_id': 'ZermeloPortal', 'client_secret': 42,
'grant_type': 'authorization_code', 'rememberMe': False}
l = requests.post(url, data=myobj)
if self.debug:
print(l.text)
jl = json.loads(l.text)
token = jl['access_token']
return(token)
def gettokenfromfile(self, file="./token", linkcode=None):
if not os.path.exists(file):
self.settokentofile(linkcode=linkcode)
with open(file) as f:
filevalue = f.read()
return str(base64.b64decode(filevalue))[2:-1]
def settokentofile(self,token=None,file="./token",linkcode=None):
if token == None:
token = self.gettokenfromlinkcode(linkcode=linkcode)
file = str(base64.b64encode(bytes(token, "utf-8")))[2:-1]
with open("./token", "w") as f:
f.write(str(file))
def get_date(self):
timezoneinforeq = requests.get("http://worldtimeapi.org/api/ip").text
if self.debug:
print(timezoneinforeq)
timezoneinfo = json.loads(str(timezoneinforeq))
localtime = time.localtime(timezoneinfo["unixtime"])
offset_h = int(str(timezoneinfo["utc_offset"]).split(":")[0].replace("+", ""))
year, week = localtime[0], timezoneinfo["week_number"]
if localtime[4] > 4:
week = int(week)+1
return year, week, offset_h
def get_raw_schedule(self, year:int=None, week:int=None) -> dict:
time = self.get_date()
if year == None:
year = time[0]
if week == None:
week = time[1]
url = f"https://ozhw.zportal.nl/api/v3/liveschedule?access_token={self.token}&{'teacher' if (self.teacher) else 'student'}={self.username}&week={year}{week}"
if self.debug:
print(url)
rawr = requests.get(url)
if self.debug:
print(rawr)
rl = json.loads(rawr.text)
return rl
def get_schedule(self,rawschedule:dict=None,year=None, week=None):
if rawschedule == None:
rawschedule = self.get_raw_schedule(year=year,week=week)
response = rawschedule["response"]
data = response["data"][0]
appointments = data["appointments"]
return(appointments)
def sort_schedule(self, schedule=None, year=None, week=None):
if(schedule == None):
schedule = self.get_schedule(year=year, week=week)
pdate = 0
days = [[[], []]]
for les in schedule:
date = datetime.utcfromtimestamp(les["start"]).strftime('%Y%m%d')
hour = str(int(datetime.utcfromtimestamp(
les["start"]).strftime('%H')) + self.TimeToAddToUtc)
time = datetime.utcfromtimestamp(les["start"]).strftime('%Y-%m-%d ') + (hour if int(
hour) > 9 else ('0'+hour)) + datetime.utcfromtimestamp(les["start"]).strftime(':%M')
ehour = str(int(datetime.utcfromtimestamp(
les["end"]).strftime('%H')) + self.TimeToAddToUtc)
etime = datetime.utcfromtimestamp(les["end"]).strftime('%Y-%m-%d ') + (ehour if int(
ehour) > 9 else ('0'+ehour)) + datetime.utcfromtimestamp(les["end"]).strftime(':%M')
# print(les["status"])
if date != pdate:
days.append([[], []])
if (les["status"][0]["code"] < 3000 and les["status"][0]["code"] >= 2000):
days[-1][0].append([les["subjects"][0], time, etime,
str(les["locations"]), les["status"], les["online"]])
else:
days[-1][1].append([les["subjects"][0], time, etime,
str(les["locations"]), les["status"], les["online"]])
pdate = date
days.pop(0)
return(days)
def readable_schedule(self, days=None, year=None, week=None):
result = ''
if(days == None):
days = self.sort_schedule(year=year, week=week)
daysofweek = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]
for i,day in enumerate(days):
if len(day[0]) > 0:
result += (daysofweek[i]+"\nstart: "+day[0][0][1]+"\tend: "+day[0][-1][2]+'\n')
else:
result += (f"{daysofweek[i]}\n")
for les in day[0]:
if (les[4][0]["code"] < 3000 and les[4][0]["code"] >= 2000):
result += ("les: "+les[0].ljust(10, " ")+"lokaal: "+("📷"if(les[5])else (les[3][2:-2]if(
len(les[3][2:-2]) > 0)else "----")).ljust(10, " ")+"\tstart: "+les[1]+"\tend: "+les[2]+'\n')
pass
result += ("\n\n")
return result
def print_schedule(self, readable=None, days=None, year=None, week=None):
if(readable == None):
readable = self.readable_schedule(days=days, year=year, week=week)
print(readable)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for zermeloapi-2022.5.20.16.21.27.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7775bc77b847ecf99f253be4828120f2bd3d3d47f95790621cc7c0bd9035e6de |
|
MD5 | 8af6583d177b135a5100fa4b0bf6eb7a |
|
BLAKE2b-256 | efdb61708ecf3f94025a3f386191366c28794d2f9887cf3e56b3c117eee177db |