firefly_reports 0.4.0

No project description provided

Firefly Reports

Generate email reports using Firefly's API. There is a wiki which will have more information.

Firefly

Firefly is a free and open source personal finance manager. Firefly Reports adds the ability to get email reports to help keep track of your spending.

Quickstart

To install, you can use pipx:

$ pipx install firefly_reports

or use uv:

$ uv tool install firefly_reports

If using pip, I would suggest using a virtual environment. After installing, you can use --help to get the inputs:

Usage: firefly_reports [OPTIONS] CONFIG_FILE

Options:
  --start_date [%Y-%m-%d]
  --end_date [%Y-%m-%d]
  --help                   Show this message and exit.

By default the start date will be a week from when the program is run and the end date will be the day of the program is run.

Copy example_config.toml to your PC and update the following:

[email]
server = "smtp.gmail.com"
port = 587
starttls = true         # Use STARTTLS
authentication = true   # Login with username and password
user = "[e-mail]"
password = "password"
from = "[e-mail]"
to = ["[e-mail]","[e-mail]"]

[firefly]
url = "http://firefly_instance:8085"
access_token = "your_api_access_token_key"

I verified that using Gmail works but haven't checked other email providers. Look at Firefly's documentation to get your access token.

Reports

Currently only one report is supported. This report will include the following:

• Categories (income and expenses).
• Total amount spent between the start and end dates.
• Total amount earned between the start and end dates.
• Total amount spent so far for the calendar year.
• Total amount earned so far for the calendar year.

Development

The recommended way is to use uv:

$ git clone [e-mail]:cetyler/firefly_reports.git
$ uv venv --python 3.13
Using Python 3.13
Creating virtualenv at: .venv
Activate with: source .venv/bin/activate
$ source .venv/bin/activate
$ uv sync --dev