Kaltsoon/python-todo-app-pdm

⚠️ Huom! Referenssisovelluksen, kuten muidenkin sovellusten plagiointi, johtaa projektin hylkäämiseen.

TodoApp

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.

Huomio Python-versiosta

Sovelluksen toiminta on testattu Python-versiolla 3.8. Etenkin vanhempien Python-versioiden kanssa saattaa ilmentyä ongelmia.

Dokumentaatio

• Käyttöohje
• Vaatimusmäärittely
• Arkkitehtuurikuvaus
• Testausdokumentti
• Työaikakirjanpito

Asennus

1. Asenna riippuvuudet komennolla:

pdm install

2. Suorita vaadittavat alustustoimenpiteet komennolla:

pdm run build

3. Käynnistä sovellus komennolla:

pdm run start

Komentorivitoiminnot

Ohjelman suorittaminen

Ohjelman pystyy suorittamaan komennolla:

pdm run start

Testaus

Testit suoritetaan komennolla:

pdm run test

Testikattavuus

Testikattavuuden voi kerätä komennolla:

pdm run coverage

Testikattavuusraportin voi tämän jälkeen generoida komennolla:

pdm run coverage-report

Raportti generoituu htmlcov-hakemistoon.

Pylint

Tiedoston .pylintrc määrittelemät tarkistukset voi suorittaa komennolla:

pdm run lint