From b1eface45db79b6df7a9e9914f8c72bf2db863ab Mon Sep 17 00:00:00 2001 From: Boyan Date: Sat, 6 Apr 2024 16:22:32 +0200 Subject: [PATCH] Updated docs --- docs/index.md | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index b49860e..15cad7a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,12 +3,38 @@ ## 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 * Log in -* Bulk download of test cases and files +* Bulk download of test cases and files~~ * Submitting files * Somewhat easy to use API to interact with courses -## [Quickstart](quickstart.md) \ No newline at end of file +## 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() +``` + + +