kindwolf.org Git repositories woobank-utils / master README.md
master

Tree @master (Download .tar.gz)

README.md @master — view rendered · raw · history · blame 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# Woobank-utils
A set of utilities around `woob bank`. [woob bank][1] is a console application able
to list your bank accounts balances on supported websites and to see the
expenses details, transfer money, etc.

## Why?
woobank-graphite was written to replace [boobank-munin][2] as part of a
Munin-to-Graphite migration.

woobank-cacher was inspired by boobank-munin's cache mechanism and serves the
exact same purpose: limiting the amount of connections to bank websites.

woobank-accounts and woobank-history allow end users to check out their
accounts from cached files instead of establishing new connections to their
bank websites.

## Limitations and known bugs

  - woobank-graphite does not send any tags;
  - woobank-accounts completely ignores "coming" operations;
  - woobank-accounts does not handle multiple currencies very well, especially when computing _the_ total.

## Description of utilities
### Common behaviour
Most utilities provided by this project will:

  - consider `-` as a filepath meaning "use standard input"
  - default to standard input if no input file are provided

### woobank-cacher
Run 1 to n `woob bank` commands and save their JSON output to file, along with a timestamp. woobank-cacher also handles "additions", i.e. the ability to insert simple, static data in the JSON output.

Usage: ``woobank-cacher [-h] [-c CONFIG]``

`CONFIG` defaults to `~/.config/woobank-utils/cacher.json`. See the conf subdirectory for a sample configuration file.

### woobank-graphite
Take a JSON file created by the "woob bank list" command and send it to a Graphite instance.

Usage: ``woobank-graphite [-h] [-gh HOST] [-gp PORT] [json_file]``

### woobank-accounts
Take a JSON file created by the "woob bank list" command and display its contents in your terminal.

Usage: ``woobank-accounts [-h] [json_file [json_file ...]]``

### woobank-history
Take a JSON file created by the "woob bank history" command and display its contents in your terminal.

Usage: ``woobank-history [-h] [-c COUNT] [json_file]``

## License
This project is licensed under [WTFPL][3].

[1]: https://woob.tech/applications/bank
[2]: https://gitlab.com/woob/woob/-/blob/master/contrib/munin/boobank-munin
[3]: http://www.wtfpl.net/