1. woobank-utils
  2. README.md
Browse code

Rename everything as this project now relies on woob.

Xavier G authored on08/10/2022 23:51:59
Showing1 changed files
README.md
History View file @732c5e7
... ... 
@@ -1,24 +1,24 @@
1 
-# Boobank-utils
2 
-A set of utilities around Boobank. [Boobank][1] is a console application able
1 
+# Woobank-utils
2 
+A set of utilities around `woob bank`. [woob bank][1] is a console application able
3 3 
 to list your bank accounts balances on supported websites and to see the
4 4 
 expenses details, transfer money, etc.
5 5
6 6 
 ## Why?
7 
-boobank-graphite was written to replace [boobank-munin][2] as part of a
7 
+woobank-graphite was written to replace [boobank-munin][2] as part of a
8 8 
 Munin-to-Graphite migration.
9 9
10 
-boobank-cacher was inspired by boobank-munin's cache mechanism and serves the
10 
+woobank-cacher was inspired by boobank-munin's cache mechanism and serves the
11 11 
 exact same purpose: limiting the amount of connections to bank websites.
12 12
13 
-boobank-accounts and boobank-history allow end users to check out their
13 
+woobank-accounts and woobank-history allow end users to check out their
14 14 
 accounts from cached files instead of establishing new connections to their
15 15 
 bank websites.
16 16
17 17 
 ## Limitations and known bugs
18 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.
19 
+  - woobank-graphite does not send any tags;
20 
+  - woobank-accounts completely ignores "coming" operations;
21 
+  - woobank-accounts does not handle multiple currencies very well, especially when computing _the_ total.
22 22
23 23 
 ## Description of utilities
24 24 
 ### Common behaviour
... ... 
@@ -27,31 +27,31 @@ Most utilities provided by this project will:
27 27 
   - consider `-` as a filepath meaning "use standard input"
28 28 
   - default to standard input if no input file are provided
29 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.
30 
+### woobank-cacher
31 
+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.
32 32
33 
-Usage: ``boobank-cacher [-h] [-c CONFIG]``
33 
+Usage: ``woobank-cacher [-h] [-c CONFIG]``
34 34
35 
-`CONFIG` defaults to `~/.config/boobank-utils/cacher.json`. See the conf subdirectory for a sample configuration file.
35 
+`CONFIG` defaults to `~/.config/woobank-utils/cacher.json`. See the conf subdirectory for a sample configuration file.
36 36
37 
-### boobank-graphite
38 
-Take a JSON file created by the "boobank list" command and send it to a Graphite instance.
37 
+### woobank-graphite
38 
+Take a JSON file created by the "woob bank list" command and send it to a Graphite instance.
39 39
40 
-Usage: ``boobank-graphite [-h] [-gh HOST] [-gp PORT] [json_file]``
40 
+Usage: ``woobank-graphite [-h] [-gh HOST] [-gp PORT] [json_file]``
41 41
42 
-### boobank-accounts
43 
-Take a JSON file created by the "boobank list" command and display its contents in your terminal.
42 
+### woobank-accounts
43 
+Take a JSON file created by the "woob bank list" command and display its contents in your terminal.
44 44
45 
-Usage: ``boobank-accounts [-h] [json_file [json_file ...]]``
45 
+Usage: ``woobank-accounts [-h] [json_file [json_file ...]]``
46 46
47 
-### boobank-history
48 
-Take a JSON file created by the "boobank history" command and display its contents in your terminal.
47 
+### woobank-history
48 
+Take a JSON file created by the "woob bank history" command and display its contents in your terminal.
49 49
50 
-Usage: ``boobank-history [-h] [-c COUNT] [json_file]``
50 
+Usage: ``woobank-history [-h] [-c COUNT] [json_file]``
51 51
52 52 
 ## License
53 53 
 This project is licensed under [WTFPL][3].
54 54
55 
-[1]: http://weboob.org/applications/boobank
56 
-[2]: https://git.weboob.org/weboob/devel/blob/master/contrib/munin/boobank-munin
55 
+[1]: https://woob.tech/applications/bank
56 
+[2]: https://gitlab.com/woob/woob/-/blob/master/contrib/munin/boobank-munin
57 57 
 [3]: http://www.wtfpl.net/
Browse code

Indicate that the project is licensed under WTFPL.

Xavier G authored on12/11/2017 00:05:28
Showing1 changed files
README.md
History View file @d72bdf5
... ... 
@@ -49,5 +49,9 @@ Take a JSON file created by the "boobank history" command and display its conten
49 49
50 50 
 Usage: ``boobank-history [-h] [-c COUNT] [json_file]``
51 51
52 
+## License
53 
+This project is licensed under [WTFPL][3].
54 
+
52 55 
 [1]: http://weboob.org/applications/boobank
53 56 
 [2]: https://git.weboob.org/weboob/devel/blob/master/contrib/munin/boobank-munin
57 
+[3]: http://www.wtfpl.net/
Browse code

Improve README.

Xavier G authored on11/11/2017 23:55:44
Showing1 changed files
README.md
History View file @92301c1
1 1 
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