🐍 Cash flow tracker.

This utility is available as a Python package on PyPI:

python3 -mpip install cashlog

There are some files in the example directory of this repo that can be useful to demonstrate how this tool works, so let's change directory first:

cd example/

We need a Python virtual environment ("venv") with some packages to do the demonstration:

python3 -mvenv venv
venv/bin/python3 -mpip install -r requirements.txt

Now we need some input data. You can take a look at the tests in test_cli.py to understand the file format and create your own CSV input file.

Tip: you can join multiple input files that are in the same format with the following command:

cat input-*.csv | (IFS= read -r header; echo "$header"; while IFS= read -r i; do [ "$i" = "$header" ] || echo "$i"; done)

Then we can compute the totals:

python3 -mcashlog --fmt-amount='{:+.2f}' --fmt-total='{:.2f}' input.csv output.csv

And finally display some nice plots using the plots.py script (which uses the Plotly Python library):

venv/bin/python3 plots.py -at output.csv

Tip: if you want to somehow filter the data before generating the plots, you can use the awk command:

awk -F, 'NR==1 || ($2+0 >= 5 || $2+0 <= -5)' output.csv > output-filtered.csv

For more details on how to use this command, you can also refer to its help message (--help).

If you want to contribute to this project, you can create a Python virtual environment ("venv") with the package in editable mode:

python3 -mvenv venv
venv/bin/python3 -mpip install -e .

This will link the package to the original location, so any changes to the code will reflect directly in your environment (source).

If you want to run the tests:

venv/bin/python3 -mpip install pytest
venv/bin/python3 -mpytest test