Ohtuminiprojekti

GitHub Actions codecov

Product backlog

täällä

Raportti

Linkki raporttiin

Definition of Done

Valmiissa ohjelmistossa määritellyt vaatimukset on analysoitu, suunniteltu, ohjelmoitu, testattu, dokumentoitu, integroitu muuhun ohjelmaan ja se on viety tuotantoympäristöön.

  • user storyt testattu monipuolisesti
  • ohjelma läpäisee CI:n, testikattavuus vähintään 70 %
  • koodi on selkeää ja ylläpidettävää
  • koodi on yhtenäistä ja noudattaa pylintissä määriteltyä tyyliä
  • product backlog ja sprint backlog ovat ajan tasalla

Ohjelma on analysoitu sekä suunniteltu ryhmässä ennen ensimmäistä sprinttiä. Sen jälkeen ohjelmasta on ohjelmoitu minimum viable product eli MVP, mikä on dokumentoitu DocString periaatteiden mukaisesti. Ohjelmaan on myös toteutettu testejä.

Tällä hetkellä

  • Ohjelmassa on tietokantayhteys.
  • Lukuvinkki tallentuu tietokantaan.
  • Lukuvinkkit voi tulostaa tietokannasta.
  • käyttäjä voi tallentaa kirja, video, blogpost, sekä podcast tyyppisiä lukuvinkkejä
  • lukuvinkille voi tallentaa tagin tai liittyvän kurssin, joiden perusteella voi hakea lukuvinkkejä
  • lukuvinkkejä voi poistaa
  • voi hakea satunnaisen lukuvinkin

Asennus

Asenna riippuvuudet komennolla:

poetry install

Komennot

Ohjelma

Komennot suoritetaan virtuaaliympäristössä komennolla:

poetry shell

Ohjelma suoritetaan komennolla:

python3 src/main.py

Testaus

Testit suoritetaan komennolla:

pytest src

Pylint

Pylint raportti saadaan komennolla:

pylint src

Coverage

Coverage raportti saadaan komennolla:

coverage run --branch -m pytest; coverage html