Browse code

Improve README.

Xavier G authored on 11/11/2017 23:55:44
Showing 2 changed files

1 1
deleted file mode 100644
... ...
@@ -1,23 +0,0 @@
1
-A set of utilities around boobank. Boobank [1] is a console application able to
2
-list your bank accounts balances on supported websites and to see the expenses
3
-details, transfer money, etc.
4
-
5
-boobank-cacher: run 1 to n boobank commands and save their JSON output to file,
6
-along with a timestamp. boobank-cacher also handles "additions", i.e. the
7
-ability to insert simple, static data in the JSON output. boobank-cacher takes
8
-no command-line arguments: everything is read from
9
-~/.config/boobank-utils/cacher.json. See the conf subdirectory for a sample
10
-configuration file.
11
-
12
-boobank-graphite: take a JSON file created by the "boobank list" command and
13
-send it to a Graphite instance.
14
-Usage: boobank-graphite <json-file> <graphite-host> <graphite-port>
15
-
16
-boobank-accounts: take a JSON file created by the "boobank list" command and
17
-display its contents in your terminal.
18
-
19
-boobank-history: take a JSON file created by the "boobank history" command and
20
-display its contents in your terminal.
21
-Usage: boobank-history <json-file> <count>
22
-
23
-[1] http://weboob.org/applications/boobank
24 0
new file mode 100644
... ...
@@ -0,0 +1,53 @@
1
+# Boobank-utils
2
+A set of utilities around Boobank. [Boobank][1] is a console application able
3
+to list your bank accounts balances on supported websites and to see the
4
+expenses details, transfer money, etc.
5
+
6
+## Why?
7
+boobank-graphite was written to replace [boobank-munin][2] as part of a
8
+Munin-to-Graphite migration.
9
+
10
+boobank-cacher was inspired by boobank-munin's cache mechanism and serves the
11
+exact same purpose: limiting the amount of connections to bank websites.
12
+
13
+boobank-accounts and boobank-history allow end users to check out their
14
+accounts from cached files instead of establishing new connections to their
15
+bank websites.
16
+
17
+## Limitations and known bugs
18
+
19
+  - boobank-graphite does not send any tags;
20
+  - boobank-accounts completely ignores "coming" operations;
21
+  - boobank-accounts does not handle multiple currencies very well, especially when computing _the_ total.
22
+
23
+## Description of utilities
24
+### Common behaviour
25
+Most utilities provided by this project will:
26
+
27
+  - consider `-` as a filepath meaning "use standard input"
28
+  - default to standard input if no input file are provided
29
+
30
+### boobank-cacher
31
+Run 1 to n boobank commands and save their JSON output to file, along with a timestamp. boobank-cacher also handles "additions", i.e. the ability to insert simple, static data in the JSON output.
32
+
33
+Usage: ``boobank-cacher [-h] [-c CONFIG]``
34
+
35
+`CONFIG` defaults to `~/.config/boobank-utils/cacher.json`. See the conf subdirectory for a sample configuration file.
36
+
37
+### boobank-graphite
38
+Take a JSON file created by the "boobank list" command and send it to a Graphite instance.
39
+
40
+Usage: ``boobank-graphite [-h] [-gh HOST] [-gp PORT] [json_file]``
41
+
42
+### boobank-accounts
43
+Take a JSON file created by the "boobank list" command and display its contents in your terminal.
44
+
45
+Usage: ``boobank-accounts [-h] [json_file [json_file ...]]``
46
+
47
+### boobank-history
48
+Take a JSON file created by the "boobank history" command and display its contents in your terminal.
49
+
50
+Usage: ``boobank-history [-h] [-c COUNT] [json_file]``
51
+
52
+[1]: http://weboob.org/applications/boobank
53
+[2]: https://git.weboob.org/weboob/devel/blob/master/contrib/munin/boobank-munin