Skip to content
fran33git edited this page Aug 9, 2026 · 2 revisions

firefly-reports

CI License: GPL v3 Python 3.11+

Generate 26 financial reports (PDF + Excel) directly from your Firefly III instance. Designed for freelancers and small businesses who want a complete annual financial overview without manual data export.

In 3 commands

git clone https://github.com/fran33git/firefly-reports.git
cd firefly-reports/firefly_reports && pip install -r requirements.txt
python main.py --url https://firefly.example.com --start 2025-01-01 --end 2025-12-31

No Firefly III instance? Run the demo with built-in mock data:

python demo.py

Navigation

User Guide Developer Guide
Installation — prerequisites, install, first run Architecture — how the pipeline works
Configuration — all options, TOML config file Adding-a-New-Report — extend the tool
Reports-Reference — all 26 reports Testing — run and write tests
Troubleshooting — common errors and debug log Contributing — code style and PR process

Output

A typical run produces files in the output directory:

output/
├── cash_flow_2025-01-01__2025-12-31.pdf
├── income_expense_2025-01-01__2025-12-31.pdf
├── transaction_register_2025-01-01__2025-12-31.pdf
├── ...                                          (22 more PDFs)
└── firefly_reports_2025-01-01__2025-12-31.xlsx

License

GPL v3

Clone this wiki locally