Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/evan-stromatias/derdiedas

A Kivy desktop app to practice German nouns
https://github.com/evan-stromatias/derdiedas

german kivy nouns python sqlite

Last synced: 22 days ago
JSON representation

A Kivy desktop app to practice German nouns

Awesome Lists containing this project

README

        

# πŸ™ Der Die Das πŸ“š



The `Der Die Das` is a [Kivy](https://kivy.org/) desktop app to practice the German nouns (gender, plural, translation, etc).

## πŸ” Prerequisites

- [Python 3.12](https://www.python.org/downloads/release/python-3125/)
- (Optional) [Poetry](https://python-poetry.org/)

## πŸ‘Ÿ Running

### Without using Poetry

```
python3.12 -m venv .venv
source .venv/bin/activate
pip install -e .
```
Finally you may run the `Der Die Das` app by executing:
```
derdiedas
```

### Build & install using Poetry
Build the Python project by running:

```
poetry build
```

Then install the python package:

```
python3.12 -m pip install /dist/der_die_das-0.1.0.tar.gz
```

Finally you may run the `Der Die Das` app by executing:
```
derdiedas
```

## πŸ—οΈ Developing

```
poetry install
```

```
poetry run derdiedas
```

## πŸ“ˆ German Nouns Data

The [`./data/all_chapters.csv`] (data/all_chapters.csv) file has all the data required to run this application. The first time you run the app run it will read the data from the `csv` file and load them to an [sqlite](https://www.sqlite.org/) database.

However, it's possible to also use your own `csv` file. The only requirement is that it needs to have the following headers:

- `gender`
- `noun`
- `plural`
- `translation`

For example:

```
gender,noun,plural,translation
die,Begrüßung,-en,the greeting
das,Foto,-s,the photo
der,Herr,-en,the gentleman
```

then you can load the `csv` data to the database by running:
```
poetry run derdiedas_db -c PATH/TO/YOUR/CSV/FILE.csv
```

Alternatively if you have installed the project without Poetry:
```
derdiedas_db -c PATH/TO/YOUR/CSV/FILE.csv
```

# 🀌🏻 Future work
- Port to Android