Financial Vault Ledger (vaults)

A personal vault ledger with interest, statements, and analytics.

NOTE: This project was generated with Cookiecutter along with @clamytoe's toepack project template.

Initial setup

cd Projects
git clone https://github.com/clamytoe/vaults.git
cd vaults

Anaconda setup

If you are an Anaconda user, this command will get you up to speed with the base installation.

conda env create -f environment.yml
conda activate vaults

Regular Python setup

If you are just using normal Python, this will get you ready, but I highly recommend that you do this in a virtual environment. There are many ways to do this, the simplest using venv.

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Final setup

pip install -e .

Development setup

pip install -e .[dev]

Usage

vaults --help

 Usage: vaults [OPTIONS] COMMAND [ARGS]...

 Vaults CLI

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.                                              │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.       │
│ --help                        Show this message and exit.                                                            │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ summary       Show vault summary                                                                                     │
│ statement     Show vault statement                                                                                   │
│ vaults        Manage vaults.                                                                                         │
│ transactions  Manage transactions.                                                                                   │
│ rates         Manage APY rate history.                                                                               │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

The files generated by the program are stored in the ~/.vault directory in your home folder.

(vaults) ➜  ~ cd .vault
(vaults) ➜  .vault tree
.
├── posting.csv
├── rates.csv
├── transactions.csv
└── vaults.csv

0 directories, 4 files

Contributing

Contributions are welcomed. Tests can be run with with pytest -v, please ensure that all tests are passing and that you've checked your code with the following packages before submitting a pull request:

• black
• mypy
• pytest-cov
• ruff

I am not adhering to them strictly, but try to clean up what's reasonable.

License

Distributed under the terms of the MIT license, "vaults" is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Changelog

• v0.1.0 Initial commit.