Metadata-Version: 2.4
Name: pybookkeeper
Version: 0.11.0
Summary: Utility for small-scale Finnish double-ledger bookkeeping
Author-email: "Sami J. Lehtinen" <sjl+bookkeeper@iki.fi>
Project-URL: repository, https://github.com/sjlehtin/bookkeeper.git
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: lark-parser
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: tox-uv; extra == "dev"

# Bookkeeper

## Introduction

This is a simple double-ledger bookkeeping tool for a small business, operated from the command line. 

## Installation

```shell
pip install pybookkeeper
```

## Usage

Create a directory for your ledger, and run `bookkeeper` from there. 
Your directory should contain `ledger-defs.txt`, which defines your ledger map, and the outline of the generated statements.

The transactions for accounts are stored in `data-YYYY-MM.txt` files.

For example, for year 2025, you would have:

- directory `2025`
- file `2025/ledger-defs.txt`
- files `2025/data-2025-01.txt`, `2025/data-2025-02.txt`, etc.

Running

```shell
bookkeeper 2025 
```

will generate in directory `output/`, which is created if it does not exist, 
the files `general-ledger.txt`, `statement.txt` and `journal.txt`.

You can change the output directory with `--output-directory`, as follows

```shell
bookkeeper 2025 --output-directory 2025-books
```

## Release process

- [ ] Update version in `pyproject.toml`
- [ ] Update ChangeLog
- [ ] Run tests with `tox`
- [ ] Tag release
