Skip to main content

A api for schoolware written in python

Project description

Schoolware-api

An api for schoolware written in python

Capabilities

  • get agenda points
  • get scores
  • get todo items
  • send telegram message for new scores
  • support for microsoft and schoolware login

Config

Key Description
domain domain name of schoolware
user school microsoft email
password school microsoft password
schoolware_login set true if using schoolware login
bg background procces to keep token valid
bot_token telegram bot token to enable telegram bot
chat_id id to send messages to
verbose show a some more info
debug show a some more info

Install

  • pip3 install schoolware_api --upgrade
  • playwright install && playwright install-deps

optional

  • pip3 install python-telegram-bot needed for telegram

Simple example

from schoolware_api import schoolware

config = {"domain":"", "user":"", "password":""} #example domain: kov.schoolware.be user: name.lastname@leerling.kov.be password: password 

Schoolware = schoolware(config)

print(Schoolware.todo())  # Returns all todo items
print(Schoolware.punten()) # Returns all scores this schoolyear
print(Schoolware.agenda()) # Returns agenda points today
print(Schoolware.agenda(datum="2023-03-06 00:00:00")) # Returns agenda points for 2023-03-06

Complete example

from schoolware_api import schoolware
config = {"domain":"","password":"","user":"","schoolware_login": "false","verbose": false, "bg": true, "bot_token": "", "chat_id": ""}

Schoolware = schoolware(config)

# same as other

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

schoolware_api-1.2.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

schoolware_api-1.2.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file schoolware_api-1.2.0.tar.gz.

File metadata

  • Download URL: schoolware_api-1.2.0.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for schoolware_api-1.2.0.tar.gz
Algorithm Hash digest
SHA256 4a01dca7b151aca5c0b3943c7357ff9e65c01eb335e679ca4f321f738210fa8d
MD5 b66ab806bc7966d4962c18a78b3a0e46
BLAKE2b-256 05f024b6fca1b13fd54951cc48b268280491e1204cffa89b2999b71cf08a1fa7

See more details on using hashes here.

File details

Details for the file schoolware_api-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: schoolware_api-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for schoolware_api-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e51ea5705edad13b90ffd3775aa7158f7d278041b0d407f760c179d8c2497964
MD5 8443520c476ecb4a74fd97fe75b161b9
BLAKE2b-256 a9a9504b7b305b28652ecd9aceedeeb22a2a89abff24ff3443d07f37a2c22091

See more details on using hashes here.

Supported by

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