KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

YNAB-reporter

★ 41 Open GitHub ↗

Reporting system for You Need A Budget

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# YNAB reporter: a simple YNAB monthly reporting system
This repository implements a small system for generating reports summarising You Need A Budged monthly movements and historical positions. The data is obtained using the YNAB API and the reports are generated using LaTeX.

## Changelog
__July 4th, 2021__
- Feat: add example Dockerfile
- Feat: add YoY column
- Several minor bugfixes

__December 3rd, 2020__
- Feat: add multi-budget functionality, with possibility of different currencies
- Feat: add possibility to exclude categories of the calculations

## Getting started
Follow the next steps to have the project running in your system:

1. Install [pyenv](https://github.com/pyenv/pyenv) and [poetry](https://python-poetry.org/) in your system following the linked official guides.
2. Open a terminal, clone this repository and `cd` to the cloned folder.
3. Run `pyenv install $(cat .python-version)` in your terminal for installing the required python.
   version.
4. Configure poetry with `poetry config virtualenvs.in-project true`.
5. Create the virtual environment with `poetry install`.
6. Make sure you have LaTeX installed in your system (or install it with `sudo apt-get install texlive-full`) with the needed dependencies.
7. Create the `config/ynab.toml` file following the example in the same folder and fill-in your budget name and API key.
8. Do the same with the `config/email.toml` file. The example contained in this repository has the settings for gmail pre-filled in.
9. Activate the environment with `source .venv/bin/activate`.
10. Run `python main.py -y <report-year> -m <report-month>` to generate a report for the specified date.

It might be useful to set up a crontab to run the system every month. In my case, I run it the 5th day of every month, for calculating the report corresponding with the previous month. The crontab entry is shown below as an example.

```
0 9 5 * *     cd ~/projects/ynab-reporter && .venv/bin/python main.py -m `date +\%-m --date="1 month ago"` -y `date +\%Y --date="1 month ago"` -e my.email@gmail.com my.partner.email@gmail.com
```

## Example
The following image shows how the report looks like. Notice that all the data shown in it has been randomly generated.

![](https://raw.githubusercontent.com/ivallesp/YNAB-reporter/master/assets/report-example.png)

## Contribution
Pull requests and issues will be tackled upon availability.

## License
This repository is licensed under MIT license. More info in the LICENSE file. Copyright (c) 2020 Iván Vallés Pérez

YNAB-reporter

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README