Weboob » Applications »

Boobank

Boobank is a console application (part of Weboob) to display your bank accounts on supported websites (see CapBank) and to see details of expenses, do transfers, etc.

Get Boobank

This application is a part of Weboob. Download it and install it with:

$ ./setup.py install

For more information about installation of Weboob read this page.

Usage

You can run boobank without any parameter to get an interactive prompt, or specify a command to run it directly and exit just after.

In this page we will use the interactive mode:

$ boobank
Welcome to boobank

Copyright(C) 2010 Romain Bignon
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 3 of the License.

Type "help" to display available commands.

Loaded backends: bnporc, lcl, creditmutuel

boobank>

Use the help command to see what are available commands.

The first time you launch boobank, it will ask you what backends you want to add and configure. You can also use the backends command to manage them, and to enable only specific backends.

To get more information about advanced usage of boobank, see the console applications common options.

List accounts

Use this command:

boobank> list

For example:

boobank> list
                 Account                     Balance    Coming
------------------------------------------+----------+----------
 #1 (bnporc)     Compte de chèques           2161.30    -452.85
 #2 (bnporc)     Livret Jeune                1600.00       0.00
------------------------------------------+----------+----------
                                    Total    3761.30    -452.85

Display coming operations on an account

Use this command:

boobank> coming <# or ID>

For example:

boobank> coming 1255000XXXXXXXX@bnporc
+----------+----------+------------------------------------------+---------+
|    Id    |   Date   |                  Label                   |  Amount |
+----------+----------+------------------------------------------+---------+
| 0@bnporc | 20101102 | FACTURECARTEDU121010LEPETITJOURNA75PAR   | -50.0   |
| 1@bnporc | 20101102 | FACTURECARTEDU021010HALLBEERBREWE75PAR   | -47.5   |
| 2@bnporc | 20101102 | FACTURECARTEDU021010MONOPRIX124492PUTEA  | -31.16  |
| 3@bnporc | 20101102 | FACTURECARTEDU270910SNCHAUDRECHY92PUTEA  | -27.5   |
+----------+----------+------------------------------------------+---------+

Display history of an account

It's exactly like the coming operations:

boobank> history 2
+----------+------------+-----------------------------------------------------------------+---------+
|    Id    |    Date    |                              Label                              |  Amount |
+----------+------------+-----------------------------------------------------------------+---------+
| 0@bnporc | 13/10/2010 | PRELEVEMENT            CRF LA CROIX ROUGE FRANC NUM 152005 ECH  | -20.0   |
| 1@bnporc | 11/10/2010 | PRELEVEMENT            FREE TELECOM NUM 459654 ECH 11.10.10 REF | -29.99  |
| 2@bnporc | 01/10/2010 | FACTURE CARTE          DU 030910 IDF R CDG 3 SM 92 L3M2 CARTE 4 | -35.5   |
+----------+------------+-----------------------------------------------------------------+---------+

Transfer money

You can transfer money with this command:

boobank> transfer ACCOUNT [TO AMOUNT [REASON]]

For example:

boobank> transfer 1 2 50 test
------- Transfer 20101031@bnporc -------
Date:       2010-10-31 12:35:58.407272
Origin:     Compte de chèques
Recipient:  Livret jeune
Amount:     50.00

Use cases

Reuse data in accounting software

To export your account informations in a qif file (which can be imported in personal account manager like grisbi) you can use this command:

boobank history -f qif > dump.qif

Display accounts in Conky

You can add this line in ~/.conkyrc to display an account and its balance every 3600 seconds:

$color${texeci 3600 boobank list -f simple --no-keys --select label,balance --condition id=0837462379182736@bnporc}

To get more information about parameters used in this command, see the console applications common options.

Monitor accounts with Munin

Munin is a tool to graph on web pages system status (for example CPU usage, network traffic, etc.).

boobank-munin is a plugin to get accounts list and graph into munin.

To use it, create on a munin node a symlink to boobank-munin in the plugins directory:

$ ln -s /path/to/munin-boobank /etc/munin/plugins/boobank

Then, add this section in /etc/munin/plugin-conf.d/munin-node:

[boobank]
user romain
group romain
# Useful for weboob to find its config files.
env.HOME /home/romain/
# Monitored accounts. If this parameter is missing, all accounts
# will be displayed.
env.boobank_monitored 0125XXXXXXXXXXXX@bnporc 0125XXXXXXXXXXXX@bnporc
# To prevent mass connections to bank websites, results are cached.
# You can set here the expiration delay (in seconds).
env.boobank_cache_expire 3600
# If enabled, coming operations are added to the value of accounts'
# balance.
env.boobank_add_coming 1

Restart munin-node, then a graph will appear:

Also available in: HTML TXT