Verified Commit 733b1384 authored by Jakob Moser's avatar Jakob Moser
Browse files

Update README with new capabilities

parent ac767264

README.md

+29 −3
Original line number Diff line number Diff line
@@ -12,15 +12,41 @@ source venv/bin/activate 
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



### Aggregate expenses from payment order PDFs

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



```bash

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

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

```



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

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 €

```



## Footnotes