https://github.com/uasal/budgie
Budgie the budget tool
https://github.com/uasal/budgie
budgets python-package reports toolkit
Last synced: 4 months ago
JSON representation
Budgie the budget tool
- Host: GitHub
- URL: https://github.com/uasal/budgie
- Owner: uasal
- License: gpl-3.0
- Created: 2025-01-24T19:16:30.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2025-07-24T20:48:47.000Z (10 months ago)
- Last Synced: 2025-07-25T01:39:04.990Z (10 months ago)
- Topics: budgets, python-package, reports, toolkit
- Language: Python
- Homepage:
- Size: 19 MB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Budgie
_Budgie the budget tool_
**NOTE:** In order for this to work, data yaml files must be added to the data directory (currently) but will be able to specify in the future via command line. Name of package is budgets currently but will be changed over to budgie per opened issues.
Use the `test.sh` and edit the data file names with the names of the actual ones added to the data directory to run a report test for the budgets added. This will install the budgie package as well in the process.
## Plantuml Diagrams
A 'demo' for visualizing the initial budget yaml files is added to this tool and requires [`plantuml`](https://plantuml.com) (plantuml.jar is provided).
**Future Implementation:** Using just graphviz or something similar will require some modifications on the `budgets.py` to prevent repeating of some code aspects and improve reporting mechanics. Plantuml will no longer be needed for the diagram portion in that implementation. In order to use `budgie`, you do **not** need to have plantuml for the other functions.
## Related Documents
- [STP Budget Package Description](docs/design_description.md)