https://github.com/fabian-thomas/cakecmsutils
Python scripts to interact with the CakeCMS API.
https://github.com/fabian-thomas/cakecmsutils
cakecms cms download materials uds
Last synced: 6 months ago
JSON representation
Python scripts to interact with the CakeCMS API.
- Host: GitHub
- URL: https://github.com/fabian-thomas/cakecmsutils
- Owner: fabian-thomas
- License: mit
- Created: 2022-01-29T17:33:01.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-06T18:46:54.000Z (over 3 years ago)
- Last Synced: 2025-10-25T07:29:05.734Z (8 months ago)
- Topics: cakecms, cms, download, materials, uds
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Python scripts to interact with the [CakeCMS API](https://cms.cispa.saarland/system/help/api).
## Installation of the python module
### Prerequisites (in both below cases)
The [cakecms module](https://gitea.mk-bauer.de/CakeCMS/CakeCMS-Python-API) has to be installed first.
### From PyPi
```bash
pip install cakecmsutils
```
### From source
Install the PyPI package `build`:
```bash
pip install build
```
Then (from the root of the repo):
```bash
python -m build
pip install dist/*.whl
```
## Example scripts
For obtaining the right values for `HOST`, `TOKEN` and `COURSE` refer to [CakeCMS API](https://cms.cispa.saarland/system/help/api).
### Download course materials (examples/download_course_materials.py)
This script may be used to download course materials by category. The example script also shows how a negative filter may be used to skip some of the files. Note that `ExtendedCakeCMS` writes data to a hidden cache file in your PWD. This cache file makes sure that no files need to be redownloaded.
This script should probably be copied to a separate directory for each of your courses and then adjusted to match the categories. The category titles are the ones visible in the headers on the webpage.