temmies/docs/index.md

41 lines
784 B
Markdown
Raw Normal View History

# Temmies!
<center>![Temmie](img/rugemmie.gif)</center>
## What is this?
2024-04-06 16:22:32 +02:00
A python library which interacts with themis. Uses bs4. I'll try to end development on a somewhat working state. [Check out the code](https://github.com/Code-For-Groningen/temmies)
## Intended Features
* Log in
2024-04-06 16:22:32 +02:00
* Bulk download of test cases and files~~
* Submitting files
* Somewhat easy to use API to interact with courses
2024-04-06 16:22:32 +02:00
## Installation
```bash
pip install temmies
```
## Example Usage
```python
import temmies
# Log in
themis = temmies.Themis("s-number", "password")
# Get a year
year = themis.getYear(2023, 2024)
# Get a course
pf = year.getCourse("Programming Fundamentals (for CS)")
# Get an assignment
assignment = pf.getExerciseGroups()
# Download the files
assignment.downloadFiles()
```