~mendelmaleh/pfin

f6dbf20b284e5c6ead9b8ff5047db6d6b2dd7d2d — Mendel E 17 days ago 894d1ba
Add initial readme
1 files changed, 17 insertions(+), 0 deletions(-)

A README.md
A README.md => README.md +17 -0
@@ 0,0 1,17 @@
# pfin: personal finance tools

Collection of tools for parsing bank statements and csvs.

[![Go Documentation](https://godocs.io/git.sr.ht/~mendelmaleh/pfin?status.svg)](https://godocs.io/git.sr.ht/~mendelmaleh/pfin)

# structure

- `pfin`: base library, defines transaction and parser interfaces, parser loading utility like database/sql
- `pfin/util`: Utils for directory parsing, filter flags, and formatting functions
- `pfin/parser`: parser implementations
- `pfin/parser/util`: common code for parsers
- `pfin/parser/all`: metapackage to load all parser implementations

- `cmd/main`: prints out all transactions, can filter by account/user and sums by user
- `cmd/unpaid`: get a list of unpaid transactions for a user
- `cmd/status`: wip, get an overview of the statements tree