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

Add more style

parent 227bc51b
Loading
Loading
Loading
Loading
+17 −33
Original line number Diff line number Diff line
# Muffin

Maintainer: Jakob Moser <moser@cl.uni-heidelberg.de>
<div align="center">

<img src="img/logo.png" width="150px"/>
</div>

[[_TOC_]]

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
Maintainer: Jakob Moser <moser@cl.uni-heidelberg.de>

## 📦 Installation

You need Git and Python >= 3.11 installed.

```bash
git clone https://gitlab.cl.uni-heidelberg.de/moser/muffin
cd muffin
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
@@ -14,40 +25,13 @@ pip install -r requirements.txt

Furthermore, you need to install [`tabula-java`](https://github.com/tabulapdf/tabula-java) and make sure the command `tabula` is on PATH.

## Features

### Calculate how much money has already been spent for each budgetary item
## 🏃 Running

```bash
python3 -m muffin /path/to/folder/with/payment_order_pdfs /path/to/current/budget_plan.pdf
```

Output is a table like this:

```
  Budgetposten  Name                                                                   Ausgegeben    Verbleibend    Geplant
--------------  -------------------------------------------------------------------  ------------  -------------  ---------
       100.021  VS-Beiträge                                                                0,00 €      3275,00 €  3275,00 €
       210.021  Spenden, Zuschüsse                                                         0,00 €       200,00 €   200,00 €
       221.021  Einnahmen Veranstaltungen zur Orientierung, Beratung und Vernetzung        0,00 €      2460,00 €  2460,00 €
       223.021  Einnahmen aus kulturellen Veranstaltungen                                  0,00 €       250,00 €   250,00 €
       250.021  Einnahmen Betrieb gewerblicher Art                                         0,00 €       500,00 €   500,00 €
       290.021  sonstige Einnahmen                                                         0,00 €         0,00 €     0,00 €
       321.021  Zweckgebundene Rücklagen von FSen                                          0,00 €       900,00 €   900,00 €
       513.021  Weitere Ausstattung                                                        0,00 €       380,00 €   380,00 €
       516.021  Putz- und Pflegemittel                                                     0,00 €        10,00 €    10,00 €
       531.021  Dienstreisen                                                               0,00 €       140,00 €   140,00 €
       533.021  Transportkosten                                                            0,00 €       100,00 €   100,00 €
       540.021  Bewirtungskosten und Lebensmittel                                          0,00 €       145,00 €   145,00 €
       590.021  Steuern und Abgaben                                                        0,00 €         0,00 €     0,00 €
       710.021  Inhaltliche Projekte & Veranstaltungen                                     0,00 €        30,00 €    30,00 €
       721.021  Veranstaltungen Orientierung und Vernetzung in HD                          0,00 €      2760,00 €  2760,00 €
       740.021  Projekte und Veranstaltungen kultureller Art                               0,00 €       550,00 €   550,00 €
       750.021  Externe Verpflegung                                                        0,00 €      2490,00 €  2490,00 €
       780.021  Betrieb gewerblicher Art                                                   0,00 €         0,00 €     0,00 €
       790.021  Sonstige Ausgaben der Fachschaft                                           0,00 €       980,00 €   980,00 €
source venv/bin/activate
python3 -m muffin
```

## Footnotes
## 👣 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”.

img/logo.png

0 → 100644
+1.31 MiB
Loading image diff...