aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 98c59d3324d31e99320d2e7a8565cfb35bf8707a (plain) (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
# jali

## About
This is a small python3 program to import transactions from your bank via aqbanking and insert it automagically in your ledger files.

## Requirements
* `python3`
* `jinja`, `pendulum` for members extension
* `ledger` http://ledger-cli.org/
* `aqbanking` http://www2.aquamaniac.de/sites/aqbanking/index.php

## Get started

* Install `python3`, `ledger` and `aqbanking`
* Install `jinja` and `pendulum` via pip or your package manager.
* Run `pip install (--user) .`
* Configure aqbanking, you can try it with the commandline, actually gnucash has a nice wizard for this on board, you can try it, if you can’t find another way.
* Run `jali`


## Configuration

* Run `jali --help` for options.
* Copy `example-config.py` to `~/.config/jali/config.py` to configure.
* `jali` will put your files in `~/ledger` if you don’t configure it.
* `jali` will use your configured locale to determine the formatting of currencies. You can change that in the settings.

## Contribution

We are always happy about bug reports, enhancement suggestions or pull requests.

Feel free to talk to us on matrix (`#jali:darmstadt.ccc.de`) or irc (`ircs://irc.hackint.org/jali`).

Or contact @maralorn:
~~~
malte.brandy@maralorn.de
@maralorn:maralorn.de
maralorn @ irc.hackint.eu
~~~

## License

MIT License see `LICENSE` file