Shekels is a local service which consumes a transactions CSV file downloaded from mint.intuit.com. It conforms this data into a database, and displays it as a searchable table and dashboard of configurable plots in web frontend.
See documentation for details.
On the documentation main page, under the Architecture section, is a dynamically generated dependency graph of shekels's current architecture. It is generated using the RepoETL class.
If you look under the Metrics section you will find Radon code metric plots and data of the shekels source code, generated by the RadonETL class.
pip install shekels
- Install docker-desktop
docker pull thenewflesh/shekels:latest
- Install docker-desktop
- Ensure docker-desktop has at least 4 GB of memory allocated to it.
git clone git@github.com:theNewFlesh/shekels.gitcd shekelschmod +x bin/shekelsbin/shekels docker-start
The service should take a few minutes to start up.
Run bin/shekels --help for more help on the command line tool.
shekels comes with a command line interface defined in command.py.
Its usage pattern is: shekels COMMAND [ARGS] [FLAGS] [-h --help]
Prints BASH completion code to be written to a _shekels completion file
Usage: shekels bash-completion
Prints ZSH completion code to be written to a _shekels completion file
Usage: shekels zsh-completion
bin/shekels is a command line interface (defined in cli.py) that works with any version of python 2.7 and above, as it has no dependencies.
Its usage pattern is: bin/shekels COMMAND [-a --args]=ARGS [-h --help] [--dryrun]
| Command | Description |
|---|---|
| build-package | Build production version of repo for publishing |
| build-prod | Publish pip package of repo to PyPi |
| build-publish | Run production tests first then publish pip package of repo to PyPi |
| build-test | Build test version of repo for prod testing |
| docker-build | Build image of shekels |
| docker-build-prod | Build production image of shekels |
| docker-container | Display the Docker container id of shekels |
| docker-destroy | Shutdown shekels container and destroy its image |
| docker-destroy-prod | Shutdown shekels production container and destroy its image |
| docker-image | Display the Docker image id of shekels |
| docker-prod | Start shekels production container |
| docker-push | Push shekels production image to Dockerhub |
| docker-remove | Remove shekels Docker image |
| docker-restart | Restart shekels container |
| docker-start | Start shekels container |
| docker-stop | Stop shekels container |
| docs | Generate sphinx documentation |
| docs-architecture | Generate architecture.svg diagram from all import statements |
| docs-full | Generate documentation, coverage report, diagram and code |
| docs-metrics | Generate code metrics report, plots and tables |
| library-add | Add a given package to a given dependency group |
| library-graph-dev | Graph dependencies in dev environment |
| library-graph-prod | Graph dependencies in prod environment |
| library-install-dev | Install all dependencies into dev environment |
| library-install-prod | Install all dependencies into prod environment |
| library-list-dev | List packages in dev environment |
| library-list-prod | List packages in prod environment |
| library-lock-dev | Resolve dev.lock file |
| library-lock-prod | Resolve prod.lock file |
| library-remove | Remove a given package from a given dependency group |
| library-search | Search for pip packages |
| library-sync-dev | Sync dev environment with packages listed in dev.lock |
| library-sync-prod | Sync prod environment with packages listed in prod.lock |
| library-update | Update dev dependencies |
| library-update-pdm | Update PDM |
| session-app | Run app |
| session-lab | Run jupyter lab server |
| session-python | Run python session with dev dependencies |
| state | State of shekels |
| test-coverage | Generate test coverage report |
| test-dev | Run all tests |
| test-fast | Test all code excepts tests marked with SKIP_SLOWS_TESTS decorator |
| test-lint | Run linting and type checking |
| test-prod | Run tests across all support python versions |
| version | Full resolution of repo: dependencies, linting, tests, docs, etc |
| version-bump-major | Bump pyproject major version |
| version-bump-minor | Bump pyproject minor version |
| version-bump-patch | Bump pyproject patch version |
| zsh | Run ZSH session inside shekels container |
| zsh-complete | Generate oh-my-zsh completions |
| zsh-root | Run ZSH session as root inside shekels container |
| Short | Long | Description |
|---|---|---|
| -a | --args | Additional arguments, this can generally be ignored |
| -h | --help | Prints command help message to stdout |
| - | --dryrun | Prints command that would otherwise be run to stdout |