boyan_k/temmies
boyan_k/temmies
1
0
Fork 0
mirror of https://github.com/Code-For-Groningen/temmies.git synced 2025-03-15 15:10:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Boyan 2024-04-06 16:22:32 +02:00
parent b8a6e05ea0
commit b1eface45d
1 changed files with 29 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/index.md
View File

@ -3,12 +3,38 @@
## What is this? ## What is this?
A python library which interacts with themis. Uses bs4. I'll try to end development on a somewhat working state. 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 ## Intended Features
* Log in * Log in
* Bulk download of test cases and files * Bulk download of test cases and files~~
* Submitting files * Submitting files
* Somewhat easy to use API to interact with courses * Somewhat easy to use API to interact with courses
## [Quickstart](quickstart.md) ## 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()
```