temmies/docs/index.md

41 lines
850 B
Markdown
Raw Permalink 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
from temmies.themis import Themis
2024-04-06 16:22:32 +02:00
# Log in
2024-11-17 22:06:06 +01:00
themis = Themis("s-number") # You will be prompted for your password
2024-04-06 16:22:32 +02:00
# Get a year
2024-11-18 20:17:26 +01:00
year = themis.get_year("2023-2024")
2024-04-06 16:22:32 +02:00
# Get a course
course = year.get_course("Programming Fundamentals (for CS)")
2024-04-06 16:22:32 +02:00
# Get an assignment
2024-06-03 22:55:36 +02:00
assignment = course.get_group("Assignment 1")
2024-04-06 16:22:32 +02:00
# Submit 2 files
assignment.submit(["among.c", "us.py"])
2024-04-06 16:22:32 +02:00
```