Sovelluksen avulla käyttäjien on mahdollista pitää kirjaa tekemättömistään töistä eli todoista. Sovellusta on mahdollista käyttää useamman rekisteröityneen käyttäjän, joilla kaikilla on oma yksilöllinen tehtävälistansa.
Sovellus toimii myös Helsingin yliopiston Tietojenkäsittelytieteen kurssin Ohjelmistotekniikan menetelmät referenssisovelluksena. Sovelluksen tarkoituksena on demonstroida erästä tapaa tehdä suurin piirtein täysiin pisteisiin riittävä dokumentaatio sekä testaus projektillesi. Itse ohjelma on sen verran suppea, että saadaksesi kurssilta arvosanan 5 joudut tekemään hieman laajemman sovelluksen.
Sovelluksen toiminta on testattu Python-versiolla 3.8
. Etenkin vanhempien Python-versioiden kanssa saattaa ilmentyä ongelmia.
- Asenna riippuvuudet komennolla:
poetry install
- Suorita vaadittavat alustustoimenpiteet komennolla:
poetry run invoke build
- Käynnistä sovellus komennolla:
poetry run invoke start
Ohjelman pystyy suorittamaan komennolla:
poetry run invoke start
Testit suoritetaan komennolla:
poetry run invoke test
Testikattavuusraportin voi generoida komennolla:
poetry run invoke coverage-report
Raportti generoituu htmlcov-hakemistoon.
Tiedoston .pylintrc määrittelemät tarkistukset voi suorittaa komennolla:
poetry run invoke lint