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.7.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.7.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: schoolware_api-1.7.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.7.0.tar.gz
Algorithm Hash digest
SHA256 71bd3c10a024983f11ea37942012ecfa41266a3339237eaf6e865b759c86b850
MD5 26509d1865d36ba6fa48d6da86d4aa57
BLAKE2b-256 7b57adcab353e3ea1d8540ce3375eebda85003e1693056471de966b5e5b7bdea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: schoolware_api-1.7.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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 57fa2ef7c53b93c8b89f88410e936e90768e1b88f7edd712622c6f3fe3f9eb1b
MD5 93a28472c1e523711e8078ec5aaaf51b
BLAKE2b-256 fa9e556dd54a84dd4e9f0d2e63e90b276fbf202415ea27e457d2e7cd93a0db1d

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