aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 9f10197023527cb33c381517a767ad37fdb5e721 (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
# xembu - eXtensiblE Multiuser Bookkeeping Utility

This tool does simple bookkeeping statistics based on CSV input.

## Installation

1. Clone this repository and `cd` into the project directory.
2. Initialize python venv: `python -m venv .venv`
3. Activate venv: `source .venv/bin/activate`
4. Install requirements: `pip install -r requirements.txt`

## Usage

```
usage: xembu.py [-h] [--title TITLE] [--pdf PDF] [--bundle BUNDLE] csv

positional arguments:
  csv                  CSV path

options:
  -h, --help           show this help message and exit
  --title, -t TITLE    Title in PDF header (optional)
  --pdf, -p PDF        Target PDF path (optional)
  --bundle, -b BUNDLE  Path to bundle (.tar.zst), containing CSV, PDF and receipts (optional)
```
```