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.5.0.tar.gz (6.5 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.5.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for schoolware_api-1.5.0.tar.gz
Algorithm Hash digest
SHA256 58e6376b676baa0d651dc331faff27c668ca0e978ceb42578741a544b6fe6e11
MD5 c1d38a4c9230bbdaa34169a761150179
BLAKE2b-256 50c6b6251516606070ef1f1b5a8c08d7610fef0d75c1d2e4ce63c34481432e29

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for schoolware_api-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ea301001b2d045ae38b0d315eedcd60a1d82659b5a345534dcfe87dfebbd39d0
MD5 8b174fd68bd6613a54e6d7f3b21d19ce
BLAKE2b-256 7888551097e59a5bbf0b6d36dd21e998a883b051dcd59eb167583b69d561fc7a

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