Write some docs on how to use

This commit is contained in:
fleaz 2023-07-31 20:35:31 +02:00
parent 9d13443999
commit 55bc5f0360
No known key found for this signature in database
GPG key ID: AED15F8FDD04D083

View file

@ -1,15 +1,41 @@
# schmeckels
## ToDo
## Installation
You need to have Python >= 3.8 and Poetry installed. Then you can run `poetry install` to create a virtuelenv and download all dependencies.
- Graphen
- Linechart Verlauf über Monate (Gesamtetrag)
- Piechart verschiedene Tags
- Übersicht auf Startseite
- Monatsübersicht dieser/letzter Monat
- Anzahl ungetaggte Transaktionen
- Doku
## Usage
It's currently not packages so you have to use `poetry run schmeckels <cmd>`.
Run it without a command to get a small help page listing all commands.
## Commands
### init
Run this once to create empty database and rules files
### info
This will print some informations about your sorted/unsorted transactions and also show the location of your config
files.
### import
Run this to import CSV's from your bank
### validate
Check the syntax of your rules. Good thing to do before running e.g. autosort
### autosort
Run your defined rules against all unsorted transactions. Run with "-v --dry-run" after writing new rules is a good
practice.
### serve
Start the web interface.
### sort
Manually sort all unsorted transactions.
### stats
Render a really simple EUR (Einnahmen Überschuss Rechnung).
restart
## Example rules
The rules file must be valid YAML and contain a list of all rules. A rule must contain: