Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaltsoon/python-todo-app-pdm
https://github.com/kaltsoon/python-todo-app-pdm
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/kaltsoon/python-todo-app-pdm
- Owner: Kaltsoon
- Created: 2021-12-10T07:16:22.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-10T07:57:55.000Z (about 3 years ago)
- Last Synced: 2023-04-06T05:12:20.402Z (almost 2 years ago)
- Language: Python
- Size: 1.53 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
⚠️ **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](./dokumentaatio/kayttoohje.md)
- [Vaatimusmäärittely](./dokumentaatio/vaatimusmaarittely.md)
- [Arkkitehtuurikuvaus](./dokumentaatio/arkkitehtuuri.md)
- [Testausdokumentti](./dokumentaatio/testaus.md)
- [Työaikakirjanpito](./dokumentaatio/tuntikirjanpito.md)
## Asennus
1. Asenna riippuvuudet komennolla:
```bash
pdm install
```
2. Suorita vaadittavat alustustoimenpiteet komennolla:
```bash
pdm run build
```
3. Käynnistä sovellus komennolla:
```bash
pdm run start
```
## Komentorivitoiminnot
### Ohjelman suorittaminen
Ohjelman pystyy suorittamaan komennolla:
```bash
pdm run start
```
### Testaus
Testit suoritetaan komennolla:
```bash
pdm run test
```
### Testikattavuus
Testikattavuuden voi kerätä komennolla:
```bash
pdm run coverage
```
Testikattavuusraportin voi tämän jälkeen generoida komennolla:
```bash
pdm run coverage-report
```
Raportti generoituu _htmlcov_-hakemistoon.
### Pylint
Tiedoston [.pylintrc](./.pylintrc) määrittelemät tarkistukset voi suorittaa komennolla:
```bash
pdm run lint
```