To łącznik pomiędzy dowolną pocztą elektroniczną z imap a systemem CMS SGGW. Wszystko napisane w pythonie z restrykcyjnym sprawdzaniem typów.
- Zainstaluj docker oraz docker-compose
- Sklonuj repozytorium
- W pliku
docker-compose.yml
ustaw zmienne środowiskowe:EMAIL_HOST
- adres serwera imap, domyślnieimap.gmail.com
EMAIL_USERNAME
- nazwa użytkownikaEMAIL_PASSWORD
- hasło użytkownika, dla gmaila należy wygenerować hasło aplikacjiEMAIL_TIMEOUT
- czas pomiędzy sprawdzaniem skrzynki w sekundach, domyślnie20
API_URL
- adres API CMS, domyślniehttps://kampus-sggw-api.azurewebsites.net/api
API_USERNAME
- nazwa użytkownika CMSAPI_PASSWORD
- hasło użytkownika CMSALLOWED_SENDERS
- lista adresów email, z których będą akceptowane wiadomości, domyślnie pustaEMAIL_PREFIX
- prefix adresu email, domyślnie pusty
- Uruchom kontener poleceniem
docker-compose up -d
- Sprawdź czy wszystko działa poleceniem
docker-compose logs -f
- Zainstaluj python w wersji 3.11 lub wyższej
- Sklonuj repozytorium
- Zainstaluj zależności poleceniem
pip install -r requirements.txt
- Ustaw zmienne środowiskowe:
EMAIL_HOST
- adres serwera imap, domyślnieimap.gmail.com
EMAIL_USERNAME
- nazwa użytkownikaEMAIL_PASSWORD
- hasło użytkownikaEMAIL_TIMEOUT
- czas pomiędzy sprawdzaniem skrzynki w sekundach, domyślnie20
API_URL
- adres API CMS, domyślniehttps://kampus-sggw-api.azurewebsites.net/api
API_USERNAME
- nazwa użytkownika CMSAPI_PASSWORD
- hasło użytkownika CMS
- Uruchom skrypt poleceniem
python main.py
Pull requesty są mile widziane, ale proszę o zachowanie stylu kodu. Dla wygody załączony jest również folder .vscode z ustawieniami edytora oraz .devcontainer z konfiguracją kontenera deweloperskiego.