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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: studipy-0.2.1.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.1.tar.gz
Algorithm Hash digest
SHA256 eb105a2cc5b7e3a7cd00c3bab9e91701037ddd74881db3c491751253da97c713
MD5 27a15486c059df3922fdb1b186cb2316
BLAKE2b-256 54223b81380e0aafb13fe60f04009580ed3d18c1dba2995a6887442f477369b3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: studipy-0.2.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2121acc5ebca809025fbcd80cccdda198d5adfe74763f749e2c40409d572d9dc
MD5 f060827ba6060e6a1ccd39d28f821c1c
BLAKE2b-256 8237007ac075e151f9fff6fcc5d662768ecbde42090e4d8d5bfcb49d90c3f2e1

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