|Nicolas Petton fde8a86f2f||3 years ago|
|features||4 years ago|
|screenshots||4 years ago|
|test||4 years ago|
|.gitignore||4 years ago|
|.gitlab-ci.yml||4 years ago|
|CONTRIBUTING.md||4 years ago|
|COPYING||4 years ago|
|Cask||4 years ago|
|README.md||4 years ago|
|elbank-boobank.el||3 years ago|
|elbank-budget.el||4 years ago|
|elbank-common.el||4 years ago|
|elbank-compat.el||4 years ago|
|elbank-overview.el||4 years ago|
|elbank-progressbar.el||4 years ago|
|elbank-report.el||4 years ago|
|elbank-transaction.el||4 years ago|
|elbank.el||4 years ago|
|run-tests.sh||4 years ago|
Elbank is a personal finances reporting tool for Emacs. It uses Weboob for scraping data from bank websites.
You will need Emacs 25+.
Install Weboob and run
boobank configure your
Install Elbank (not in Melpa yet);
Note: Make sure to enter your username and password (or an automated script)
boobank setup, so that
boobank can retrieve transactions without
asking for them. This is currently required as Elbank will not interactively
ask for usernames or passwords.
If you do not want to store your passwords in Weboob, it is also possible to use a password manager like pass. During the setup of boobank, you can set the password to run an external command like:
Data is stored as JSON in
elbank-data-file which defaults to
You might want to customize that variable or make sure to exclude it from your
.emacs.d git repository.
elbank-overview is the entry point of Elbank. You might want to
bind it to a global key like the following:
(global-set-key (kbd "C-c e") #'elbank-overview)
Otherwise just do
M-x elbank-overview RET to get started. The overview buffer
lists all bank accounts with their current balance and a link to each account
From the overview buffer, press
r to create a new report.
Before using Elbank, make sure that
weboob is correctly configured. You can
make sure of it by evaluating
$ boobank ls and see if your bank accounts are
When opening the overview buffer for the first time, Elbank will scrap data
using weboob. Press
u to update data from weboob.
Note: Many bank website only store data for a short period of time (usually just a few months), so make sure to import on a regular basis, otherwise there will be gaps in the list of transactions.
Categorizing transactions is important when reporting with Elbank. It makes it easy to group or filter transactions based on their categories.
Transactions are automatically categorized when reporting, using
elbank-categories, an association list of the form:
'(("category1" . ("regexp1" "regexp2")) (("category2" . ("regexp")))
Where a category key can be any string. Category regexps are matched against transaction labels or raw text.
For convenience when filtering transactions by categories, it is recommended to create categories with subcategories using ":" as a separator in category keys, like in the following example:
(setq elbank-categories '(("Expenses:Food" . ("^supermarket" "^restaurant" "Local store XXX" "Bakery XXX")) ("Expenses:Rent" . ("Real Estate Agency XXX")) ("Income:Salary" . ("Bank transfer from Company XXX"))))
Note that it is not currently possible to manually add a category to a specific
transaction, you always have to rely on
elbank-categories to categorize
To set a custom category to a specific transaction, go to a transaction row in
any report and press
Transactions with a custom category will override any matching category from
Many report options can be customized from within a report buffer.
f c: Filter transactions by category, or a prefix of a category.
f p: Filter transactions by a period (leave empty for no period).
f a: Only show transactions for a specific account.
S: Select the sort column.
s: Reverse the sorting order.
G: Group transactions by a property (leave empty for no grouping).
M-n: Move forward by one period.
M-p: Move backward by one period.
You can customize
elbank-saved-monthly reports and
elbank-saved-yearly-reports to get a quick list of commonly used reports from
the overview buffer.
Here are some example reports:
(elbank-report :columns '(date label raw amount))
(elbank-report :sort-by 'amount :group-by 'category :columns '(date label amount) :period `(month ,@(last (elbank-transaction-months))))
(elbank-report :sort-by 'date :group-by 'date :columns '(label category amount) :period `(month ,@(last (elbank-transaction-months))))
Monthly Budgets are specified with
elbank-budget, an assocation list of the form:
'(("category1" . amount) ("category2" . amount))
To open a budget report, press
b from the overview buffer or
Yes, please do! See CONTRIBUTING for guidelines.
See COPYING. Copyright (c) 2017 Nicolas Petton.