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.2.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: studipy-0.2.2.tar.gz
  • Upload date:
  • Size: 18.0 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.2.tar.gz
Algorithm Hash digest
SHA256 7028e7c7044681f270f1adf229169e6ef17158c1b9ffb4357372f4023cc19fa9
MD5 6330739fa01f6d01d32f998a77429ad0
BLAKE2b-256 6b1d7f1875165de07a40c8e7c8535726d6bd5786ebc8776715fa1f123547d16e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: studipy-0.2.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7871f3c2934cf61759a964cc4002f3f3ee97a3c5b95f958cd8781e30c4e63c96
MD5 1cf09ce3a733a1f8cad4a1a601c42ea2
BLAKE2b-256 a6f998b7df910816a553e6cbd16dfd7a5f0a614e03d957f94cbe88637ed06648

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