Skip to content

Commit

Permalink
Merge pull request #1 from Kaltsoon/master
Browse files Browse the repository at this point in the history
Poetry
  • Loading branch information
Kaltsoon committed Jan 4, 2021
2 parents a00a317 + b0655ce commit bda7a7d
Show file tree
Hide file tree
Showing 20 changed files with 835 additions and 551 deletions.
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
TODOS_FILENAME=todos.csv
DATABASE_FILENAME=database.sqlite
DATABASE_FILENAME=database.sqlite
22 changes: 0 additions & 22 deletions Pipfile

This file was deleted.

223 changes: 0 additions & 223 deletions Pipfile.lock

This file was deleted.

26 changes: 11 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
⚠️ **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.
Expand All @@ -6,7 +8,7 @@ Sovellus toimii myös Helsingin yliopiston Tietojenkäsittelytieteen kurssin Ohj

## Huomio Python-versiosta

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

## Dokumentaatio

Expand All @@ -21,19 +23,19 @@ Sovelluksen toiminta on testattu Python-versiolla `3.9.0`. Etenkin vanhempien Py
1. Asenna riippuvuut komennolla:

```bash
python3 -m pipenv install
poetry install
```

2. Suorita vaadittavat alustustoimenpiteet komennolla:

```bash
python3 -m pipenv run build
poetry run invoke build
```

3. Käynnistä sovellus komennolla:

```bash
python3 -m pipenv run start
poetry run invoke start
```

## Komentorivitoiminnot
Expand All @@ -43,29 +45,23 @@ python3 -m pipenv run start
Ohjelman pystyy suorittamaan komennolla:

```bash
python3 -m pipenv run start
poetry run invoke start
```

### Testaus

Testit suoritetaan komennolla:

```bash
python3 -m pipenv run test
poetry run invoke test
```

### Testikattavuus

Testikattavuus kerätään kommenolla:

```bash
python3 -m pipenv run coverage
```

Tämän jälkeen raportin voi generoida komennolla:
Testikattavuusraportin voi generoida komennolla:

```bash
python3 -m pipenv run coverage-report
poetry run invoke coverage-report
```

Raportti generoituu _htmlcov_-hakemistoon.
Expand All @@ -75,5 +71,5 @@ Raportti generoituu _htmlcov_-hakemistoon.
Tiedoston [.pylintrc](./.pylintrc) määrittelemät tarkistukset voi suorittaa komennolla:

```bash
python3 -m pipenv run lint
poetry run invoke lint
```
6 changes: 3 additions & 3 deletions dokumentaatio/kayttoohje.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ DATABASE_FILENAME=database.sqlite
Ennen ohjelman käynnistämistä, asenna riippuvuudet komennolla:

```bash
python3 -m pipenv install
poetry install
```

Jonka jälkeen suorita alustustoimenpiteet komennolla:

```bash
python3 -m pipenv run build
poetry run invoke build
```

Nyt ohjelman voi käynnistää komennolla:

```
python3 -m pipenv run start
poetry run invoke start
```

## Kirjautuminen
Expand Down
2 changes: 1 addition & 1 deletion dokumentaatio/testaus.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ Kaikki [määrittelydokumentin](./vaatimusmaarittely.md#perusversion-tarjoama-to
Sovellus ei anna tällä hetkellä järkeviä virheilmoituksia, seuraavissa tilanteissa:

- Konfiguraation määrittelemiin tiedostoihin ei ole luku/kirjoitusoikeuksia
- SQLite tietokantaa ei ole alustettu, eli `python -m pipenv run build`-komentoa ei ole suoritettu
- SQLite tietokantaa ei ole alustettu, eli `python -m poetry run invoke build`-komentoa ei ole suoritettu
Loading

0 comments on commit bda7a7d

Please sign in to comment.