Wilma kalenteriin

Kuvaus

Wilma kalenteriin on python sovellus, joka hakee Wilmasta kotitehtävät ja lisää ne käyttäjän valitsemaan Google kalenteriin.

Sovelluksella pystyy poimimaan Wilmasta kokeet ja kotitehtävät ja lisäämään ne Google kalenteriin. Sovellus osaa myös lisätä tehtävät Habiticaan.

Päätoiminnallisuudet löytyvät WilmaTask.py tiedostosta.

Tausta

Halusin luoda sovelluksen, jolla voisin helposti lisätä Wilman kotitehtävät Google kalenteriin. Tämä helpottaa lasten kotitehtävien seuraamista.

Asennus

Suosittelen luoda virtuaaliympäristön tätä sovellusta varten. Voit lukea lisää virtuaaliympäristöstä täältä .Virtuaaliympäristön luominen onnistuu seuraavalla komennolla:

Asenna virtuaaliympäristö moduuli

pip install virtualenv

Navigoi projektin juureen ja luo virtuaaliympäristö komennolla

python3 -m venv .venv

tai

python -m venv .venv

Aktivoi virtuaaliympäristö komennolla

Windows

.venv\Scripts\activate

Linux tai Mac tietokoneissa

source .venv/bin/activate

Tiedät, että virtuaaliympäristö on aktivoitu, kun näet (.venv) komentorivellä. Nyt voit asentaa riippuvuudet siihen.

Riippuvuudet

Asenna tarvittavat kirjastot komennolla

pip install -r requirements.txt

Käyttö ensimmäisellä kerralla

Kun ajat sovellusta ensimmäisen kerran tarkistetaan toimiiko Wilma. Luo virtuaaliympäristö ja asenna riippuvuudet yllä olevin ohjein. Muuta tiedostossa muuttujat.txt olevat muuttujat haluamiksesi ja nimeä tiedosto muuttujat.py-tiedostoksi. Katsoakseen toimiiko Wilma sinun täytyy määritellä ainostaan nämä:

WILMA_URL="wilman soite yleensä .inschool.fi loppuinen"
WILMA_LOGIN="kayttajatunnus"
WILMA_PASSWORD="salasana"
WILMA_STUDENT="Etunimi Sukunimi"
WILMA_STUDENTS="Etunimi Sukunimi,Etunimi Sukunimi"
LOGIN_ROUTE = "/login"
COOKIE="Wilma2LoginID"

Älä muuta LOGIN_ROUTE ja COOKIE muuttujia.

Aja nyt Wilma.py-tiedosto. Jos saat status koodiksi 200 jne. niin olet valmis siirtämään ne Google kalenteriin ja MongoDB tietokantaan.

Mikäli saat virheen kirjautuessaan niin tarkista siirry BeautifulSoup osioon ja tarkista LOGIN_ROUTE ja COOKIE.

Google Calendar API

Tätä sovellusta varten Google Calendar API:n. Google API:n kautta pystyt lisäämään tapahtumat Google kalenteriisi. Kun ajat sovelluksen ensimmäisen kerran, API pyytää sinua kirjautumaan google tiliisi ja siten saa linkin Google kalenterisi. Scope määrittää sen mitä tällä linkillä pystyy tekemään. Ole huoleti, kaikki tieto tästä pysyy vain sinulla sillä, jos et julkaise erikseen tämän API:n (ei onnistu vahingossa) niin kukaan muu ei pääse edes luomaan tämän linkin, jos et lisää hänen sähköpostin API:in. Tarkat ohjeet löytyvät Googlen omilta sivuilta Python quickstart

HUOM! Muista valita oikean scopen tai muokkaa sen muuttujat -tiedostoon:

Koodissa on scopeksi määritelty: https://www.googleapis.com/auth/calendar.events (View and edit events on all your calendars)

Jos vaihdat scopin token.json muodostumisen jälkeen eli jos olet ensin ajanut koodin jo jollain scopilla niin poista token.json tiedosto ja aja koodi uudelleen. Tämä luo uuden token.json tiedoston uudella scopella.

Lisätiedot Google kalenterin OAuth skopeista löydät sivustolta: https://developers.google.com/identity/protocols/oauth2/scopes#calendar

Tietokanta

Tietokantana on osassa MongoDB. Lisätietoa miten luoda MongoDB tietokanta täältä.

Voit testata tietokantayhteyden ajamalla mongodbconnectiontest.py -tiedoston.

Käyttö

Tarvitset Google kalenterin id:n. Lisätietoa Google kalenterin id:stä löytyy kun menet kalenterin asetuksiin ja kopioit "Kalenterin tunnus" kohdasta kalenterin id:n.

Tarvitset myös Habitica API:n avaimet, jos haluat lisätä tehtävät Habiticaan tämän sovelluksen avulla. Lisätietoa Habitica API:n avaimista löytyy täältä.

Habitica API:n dokumentaatio löytyy täältä. Mikäli käytät Habitican API:a, muista lisätä täyttää lomakkeen, jossa kerrot mitä aiot tehdä Habitican API:lla. Lomake löytyy täältä > Notifying Staff About Your Tool

Funktiot

Funktion nimi	Kuvaus	Parametrit	Palauttaa
wilma_signin	Kirjautuu Wilmaan ja palauttaa kirjautumisen sekä sessionin.	Ei parametreja.	login_req (HTTP-vastaus), session (istunto)
wilma_student	Oppilaan hakeminen Wilmasta.	login_req (HTTP-vastaus), session (istunto), wilma_student (oppilaan nimi, oletusarvo)	oppilas_url
wilma_subject	Siirrytään oppilaan sivulle. Haetaan oppilaan sivulta aineet. Palautetaan tuple listan aineiden url ja aineen.	session (istunto), oppilas_url (oppilaan URL)	links (Lista tupleja, joissa aineiden URL ja teksti)
wilma_homeworks	Haetaan kotitehtävät ja tallennetaan tietokantaan.	session (istunto), link_url (aineen URL), subject_text (aineen teksti)	Ei palauta mitään, tulostaa ja tallentaa kotitehtävät tietokantaan. Tulostaa kotitehtävät
wilma_exams	Hakee ja tallentaa kokeiden tiedot.	session (istunto), oppilas_url (oppilaan URL)	Tulostaa kokeiden tiedot
add_unique_item_mongodb	Lisää dokumentin MongoDB-tietokantaan.	subject (aihe), description (kuvaus), start (alkamisaika), stop (loppumisaika), created (luomisaika), db (tietokanta)	Tulostaa lisäysstatus
connect_mongodb	Yhdistää MongoDB-tietokantaan.	collection (MongoDB-kokoelma)	Palauttaa MongoDB-kokoelman
find_items_mongodb	Hakee dokumentit MongoDB-kokoelmasta.	collection (MongoDB-kokoelma), query (hakuehto, oletusarvo {})	MongoDB-dokumenttien iteroitava kokoelma
refactor_events	Muotoilee MongoDB:n dokumentit Google Kalenteriin sopiviksi tapahtumiksi.	events (MongoDB:n dokumenttien lista)	Google kalenteriin sopiva muotoiltujen tapahtumien lista
google_calendar_token	Hakee Google Calendar API:n tokenit.	-	Palauttaa Google API:n credentials
show_calendar_events	Näyttää tapahtumat Google Kalenterista.	calendarID (kalenterin tunniste, oletusarvo "primary")	Tulostaa tulevat tapahtumat
create_calendar_event	Luo uuden tapahtuman Google Kalenteriin.	event (kalenteritapahtuman tiedot), calendarID (kalenterin tunniste)	Tulostaa luodun tapahtuman linkin
create_habitica_task	Lisää yhden tehtävän Habiticaan.	challenge_id (Habitican haasteen tunnus), task_data (tehtävän tiedot)	Vastausobjekti tehtävän luomisen jälkeen
create_all_habitica_tasks	Lisää useita tehtäviä Habiticaan.	challenge_id (Habitican haasteen tunnus), tasks (tehtävien lista)	Lista vastausobjekteista ja niiden tiloista
load_from_json	Lataa tehtäviä JSON-tiedostosta.	filename (JSON-tiedoston polku)	Lataa ja palauttaa tehtävät tiedostosta
refactor_to_habitica_tasks	Muotoillaan tehtävä Habiticaan sopivaksi.	text (tehtävän teksti), notes (tehtävän muistiinpanot)	Palauttaa muotoillun tehtävän Habiticaa varten
delete_from_mongodb	Poistaa dokumentteja annetusta MongoDB-kokoelmasta.	collection (MongoDB-kokoelma), query (poistoehto, oletusarvo {})	Tulostaa poistettujen dokumenttien määrän

BeautifulSoup

Tiedosto Wilma.py ja WilmaTask.py käyttää BeautifulSoup kirjastoa Wilman sivujen parsimiseen. Lisätietoa BeautifulSoupista löytyy täältä

Sen käyttö saattaa vaatia Wilma -sivuston tarkempaa tutkimista.

Kehittäjätyökalut (Developer Tools)

Seuraavat tarvitset kirjautuakseen Wilmaan. Mikäli sinulla on eri cookie ja /login -polku niin muuta ne myös muuttujat.py tiedostoon.

Navigoi Wilma -sivustolle ja avaa kehittäjätyökalut joko painamalla F12 tai oikealla hiiren näppäimellä ja valitse "Inspect".

Navigoi kehittäjätyökaluissa "Network" välilehdelle. Täppää "Preserve log" ja yritä kirjautua (pelkkä "Kirjaudu sisään" ilman tunnuksia riittää).

Nyt kehittäjätyökaluissa pitäisi näkyä login POST pyyntö. Etsi login pyyntö. Headers välilehdeltä löytyy tarvitsemanne payload tiedot. Nämä ovat otsikomme.

Lisäksi tarvitsemme session cookien. Nämä löytyvät "Cookies" välilehdeltä tai samalta paikasta, josta löysimme payload tiedot "Headers" välilehdeltä. Tarkista Set-Cookie cookien nimi.