Welcome to budget-envelopes’s documentation!¶
Console script for budget_envelopes.
budget-envelopes¶
Console script for budget_envelopes.
budget-envelopes [OPTIONS]
Options
- -b, --budgets <budgets>¶
Path to budgets csv file (fixed format)
- -t, --transactions <transactions>¶
Path to file including transactions in either csv or json format. Json should be an array of objects.
- -$, --amount-field <amount_field>¶
The field which supplying the amount of the transactions
- -D, --date-field <date_field>¶
The field supplying the date of the transaction. Can be supplied multiple times in order of priority (e.g. transaction date, booking date)
- -E, --envelope-field <envelope_field>¶
Field supplying the envelope (category) from which the money is drawn or put into. Must match categories in budgets-file
- --debit-flag-field <debit_flag_field>¶
Field supplying the debit/credit flag. Also supply –debit-flag
- --debit-flag <debit_flag>¶
Content of –debit-flag-field when transaction is a debit transaction. Otherwise credit transaction assumed.
- --first-month <first_month>¶
Supply from which month the transctions and budgets should be calculated forwards. The format is ‘2023-05’
- --last-month <last_month>¶
Supply from which month the transctions and budgets should be calculated forwards. The format is ‘2025-01’. Default value is current Month (2025-01)
- -o, --output-file <output_file>¶
Output file name for .json file
- -x, --extra-files¶
Stores multiple extra files along the envelope-stats.json: envelope-stats-history.json: Monthly development history of the envelopesenvelope-stats-aggregated.json: Yearly aggregation of the envelopesenvelope-stats.png: A somewhat weird plot of the current state.
- -S, --session <session>¶
When adding multiple files per CLI, use a session string that ties the calls together