CLI¶

Die CLI-Dokumentation wird aus dem argparse.ArgumentParser generiert. Dafür muss in read_transactions/cli.py eine Funktion build_parser() existieren, die den Parser zurückgibt.

CLI für das read_transactions-Projekt – verwaltet und startet Crawler.

usage: readtx [-h] {list,run,config} ...

Positional Arguments¶

command

Possible choices: list, run, config

Verfügbare Befehle

Sub-commands¶

list¶

Listet alle verfügbaren Crawler auf

readtx list [-h]

run¶

Startet einen bestimmten Crawler oder all

readtx run [-h] [--start Startdatum] [--end Enddatum]
           [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-o [key=value ...]] [-a]
           [--include [INCLUDE ...]] [--exclude [EXCLUDE ...]] [--dry-run]
           [-p PARALLEL]
           [crawler]

Positional Arguments¶

crawler: Name des Crawlers, z. B. amazon_visa, amex (weglassen bei –all).

Named Arguments¶

--start

Startdatum im Format (dd.mm.yyyy) (default: heute)

--end

Enddatum im Format (dd.mm.yyyy) (default: heute - 6 Monate)

-l, --log-level

Possible choices: DEBUG, INFO, WARNING, ERROR, CRITICAL

Logging-Level für den Konsolenhandler

Default: INFO

-o, --options

Zusatzparameter, siehe Klassen-Dokumentation des jeweiligen Crawlers

-a, --all

Startet alle in run_all konfigurierten Crawler

Default: False

--include

Nur diese Crawler (mit -a/–all)

--exclude

Diese Crawler ausschließen (mit -a/–all)

--dry-run

Nur anzeigen, was laufen würde

Default: False

-p, --parallel

Anzahl paralleler Prozesse (0/1 = sequentiell) - experimentell

Default: 0

config¶

Verwaltet die Konfiguration

readtx config [-h] {show,clear,edit,init,set,run-all} ...

Positional Arguments¶

action

Possible choices: show, clear, edit, init, set, run-all

Verfügbare Aktionen

Sub-commands¶

show¶

Zeigt die aktuelle Konfiguration an

readtx config show [-h] [--credentials] [--urls]

Named Arguments¶

--credentials

Zeigt nur verschlüsselte Zugangsdaten im Klartext an

Default: False

--urls

Zeigt nur die konfigurierten URLs an

Default: False

clear¶

Löscht Cache oder Datei

readtx config clear [-h] [--delete]

Named Arguments¶

--delete

Löscht zusätzlich die Datei

Default: False

edit¶

Ändert einen Config-Eintrag

readtx config edit [-h] key value

Positional Arguments¶

key: Pfad (z. B. credentials.amex.user)
value: Neuer Wert

init¶

Erstellt eine Default-Konfiguration

readtx config init [-h] [--overwrite] [--path PATH]

Named Arguments¶

--overwrite

Überschreibt bestehende Datei

Default: False

--path

Pfad zur Konfigurationsdatei (default: %USERPROFILE%/.config/read_transactions/config.yaml)

set¶

Setzt Benutzername und/oder Passwort für einen Crawler

readtx config set [-h] [--user USER] [--pwd PWD] crawler

Positional Arguments¶

crawler: Crawler-Name (z. B. amex, amazon_visa)

Named Arguments¶

--user: Benutzername
--pwd: Passwort (wird verschlüsselt gespeichert)

run-all¶

Konfiguriert, welche Crawler bei ‚run -a/–all‘ berücksichtigt werden

readtx config run-all [-h] {show,enable,disable,set} ...

Positional Arguments¶

ra_action

Possible choices: show, enable, disable, set

Aktionen

Sub-commands¶

show¶

Zeigt die run_all-Einstellungen

readtx config run-all show [-h] [-e]

Named Arguments¶

-e, --effective

Zeigt zusätzlich die tatsächlich aktivierten & verfügbaren Crawler

Default: False

enable¶

Aktiviert einen/mehrere Crawler für –all

readtx config run-all enable [-h] crawler [crawler ...]

Positional Arguments¶

crawler

1. amex ariva trade_republic

disable¶

Deaktiviert einen/mehrere Crawler für –all

readtx config run-all disable [-h] crawler [crawler ...]

Positional Arguments¶

crawler

1. amex ariva trade_republic

set¶

Setzt einen Crawler explizit auf on/off

readtx config run-all set [-h] [--off] crawler

Positional Arguments¶

crawler: Crawler-Name

Named Arguments¶

--off

auf aus setzen, sonst an

Default: False

Weitere Informationen findest du unter https://th89dd.github.io/read_transactions_fm/index.html#