zst-38-notatki/README.md

20 lines
931 B
Markdown

## zst-38-notatki
### What does this do?
This python script downloads messages from an IMAP server, blindly parses them trying to extract the shitty-formatted notes our teacher sends us, and then saves them as JSON to be served by a webserver.
### Setup
```bash
git clone https://git.mandarynki.eu/maciej/zst-38-notatki
cd zst-38-notatki
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
cp .env.sample .env
nano .env
python3 main.py
```
## LICENSE
This project is licensed under [CC0](https://creativecommons.org/publicdomain/zero/1.0/deed). You're free to do whatever the hell you want with it. If you want to, you can also consider it licensed under [WTFPL](https://en.wikipedia.org/wiki/WTFPL) or [EVVKTVH](https://evvk.com/evvktvh.html).
No guarantees are given. If you choose to use this code and you point a finger at me for messing up your stuff, I'll happily stand there and laugh at you.