kindwolf.org Git repositories woobank-utils / master
master

Tree @master (Download .tar.gz)

Woobank-utils

A set of utilities around woob bank. woob bank 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 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.