Skip to main content

A unofficial python api for Lanis

Project description

[README DE] [README EN]

LanisAPI

⚠ Notice

Because the Schulportal Hessen changes quickly and is very fragmented, some functions at specific schools or after a while may no longer work.

What is this?

It's an unofficial Python library for the Schulportal Hessen. Also available on PyPi.

Features

  • Fetch homework or other tasks.
  • Fetch substitution plan.
  • Fetch calendar events.
  • Fetch conversations.
  • Fetch all schools that have Lanis.

Overview of future Features, Problems and other things here.

How do I install it?

pip install lanisapi

Required is Python 3.11. (older versions should definitely work too but I didn't tested it.)

Example

This example gives the substitution plan.

from lanisapi import LanisClient, School

def main():
    client = LanisClient("schoolid", "name.lastname", "password")
        or: client = LanisClient(School("school", "city"), "password")
    client.authenticate()
    print(client.get_substitution_plan())
    client.close()
    
if __name__ == "__main__":
    main()

More infos at the wiki.

How can I help?

  1. You can report problems at Issues.
  2. You can suggest ideas at Issues.
  3. Contributing: You can contribute to this project either by code or improving the wiki. If you're new to contributing, look here.

Also if you like this project you can give it a star.

Credits

The Javascript project SPHclient from @alessioC42 helped me to understand the Schulportal Hessen.

The Android-App sph-planner from @koenidv helped me to understand the Level 2 encryption.

Other projects that didn't helped me but are cool:

Notice

This project isn't officially related to the Schulportal Hessen. It's only a unofficial library, supported by the community.

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

lanisapi-0.2.0.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

lanisapi-0.2.0-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file lanisapi-0.2.0.tar.gz.

File metadata

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

File hashes

Hashes for lanisapi-0.2.0.tar.gz
Algorithm Hash digest
SHA256 fec8aea44ad63389d2ed330d1da739dddc770881a4ec0b026e0d9742142b9d6e
MD5 733e416e30230bffedb595e3bf6b869c
BLAKE2b-256 20ac7c521f9bf788bb051772e8db05afb5aa1e6d317297f9845edb6a3ce5b493

See more details on using hashes here.

File details

Details for the file lanisapi-0.2.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for lanisapi-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5185c27a633404f0b1b8549e4556e1df792f97f3fb496fd4f25eab53209ed8a
MD5 6b272f2a815eb859fabc784cb0b1f3b0
BLAKE2b-256 91453b7e518676de83428b23505b1ed6e768249a413d3139b0feab8787ea8011

See more details on using hashes here.

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