Verified Commit 81229576 authored by Jakob Moser's avatar Jakob Moser
Browse files

Add basic usage instructions

parent 389de501
Loading
Loading
Loading
Loading
+20 −0
Original line number Diff line number Diff line
# Muffin

Maintainer: Jakob Moser <moser@cl.uni-heidelberg.de>

The Muffin project provides **m**ixed **u**tilities **f**or **f**inancial **i**ntelligence[^1] **n**eeds tailored for Fachschaften at the Universität Heidelberg.

## Installation

```bash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```

## Features

### Aggregate expenses from payment order PDFs

```bash
python3 -m muffin /path/to/folder/with/pdfs
```

Output is a Python dictionary, mapping each budgetary item to the sum (in Cents) of the money payed in that item.

## Footnotes

[^1]: The term “Financial Intelligence” (see [Wikipedia](https://en.wikipedia.org/wiki/Financial_intelligence)) is used very liberally here to mean “knowledge about the finances of a particular organization”.