Skip to main content

studip python api using JSONAPI

Project description

PyPI Downloads

studipy - StudIP python API

StudIP Python API wrapper using StudIPs JSONAPI

Easy to use and strongly typed

INSTALLATION

pip install --upgrade studipy

From source

poetry build
pip install dist/....

Usage - Example

import studipy
import os
from dotenv import load_dotenv

load_dotenv()

username = os.getenv("STUDIP_LOGINNAME")
password = os.getenv("STUDIP_LOGINSECRET")
base_url = os.getenv("STUDIP_BASEURL")

# create a new client object
client = studipy.Client(username=username, password=password, base_url=base_url)

# get a list of Course objects (specified in types.py)
courses = client.Courses.get_courses()
for c in courses:
        print(c.title)

Checklist

  • Auth
  • Get Users
  • Get Messages
  • Send Messages
  • Get Course Folders
  • Get Subfolders
  • Get Files in Folder
  • Upload Files
  • Delete Files
  • Change File Metadata
  • Download Files
  • Mark files read
  • Delete Messages
  • Plugin Support
  • Mark Messages Read/Unread
  • View Calendar
  • Download Calendar ics (rewrite)
  • Edit Calendar
  • Write Documentation
  • Extend Examples

Buy me a Coffee!

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

studipy-0.2.3.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

studipy-0.2.3-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file studipy-0.2.3.tar.gz.

File metadata

  • Download URL: studipy-0.2.3.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.4 Linux/6.5.0-1022-azure

File hashes

Hashes for studipy-0.2.3.tar.gz
Algorithm Hash digest
SHA256 2724a8c9bab0e5471a2c7e90c5a162b185eba19623602e6ca3f765e285bcabad
MD5 c66b32bd87471a98d4ffb1bab9e4f795
BLAKE2b-256 70d913d5015daf652d21d5a42495a6ebec95af6dd98c3d31584e30141a547898

See more details on using hashes here.

File details

Details for the file studipy-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: studipy-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.4 Linux/6.5.0-1022-azure

File hashes

Hashes for studipy-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 647c985d192ff0ac36add6587a4caf96e1840ae0c52d97d9e9157f6f4ac8d846
MD5 41d21b2cce6c7490a959e9db4daac933
BLAKE2b-256 3297da3d9d67ca03ad7815cfe545caf8ddb5836d6a5b7ef0aee87bb9b6c3587a

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