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)

Roadmap

Authentication

• Basic (Username, Password)
• Oauth

Users

• Get Users
• Get Self
• Search for Users

Messages

• Get Messages
• Send Messages
• Delete Messages
• Mark Messages Read/Unread

Files and Folders

• Get Course Folders
• Get Subfolders
• Get Files in Folder
• Upload Files
• Delete Files
• Change File Metadata
• Change File Content
• Download Files
• Create Folders
• Delete Folders
• Mark files read
• Move Folders/Files
• Copy Folders/Files (STALE)

Calendar/Schedule

• View Calendar
• Download Calendar ics
• Get Schedule for current Semester
• Edit Calendar

Plugins

You will have to implement custom plugins yourself. They might have registered JSONAPI routes, good luck

Documentation

• Write Documentation
• Extend Examples

Buy me a Coffee!