BunyMuny/README.md

32 lines
1.5 KiB
Markdown
Raw Normal View History

2020-09-26 13:25:52 +00:00
BunyMuny
===
2020-09-26 13:28:11 +00:00
[![Build Status](https://drone.bune.city/api/badges/lynnesbian/BunyMuny/status.svg)](https://drone.bune.city/lynnesbian/BunyMuny)
2020-09-26 13:25:52 +00:00
BunyMuny parses the CSV output of various bank statement listings and converts it to something more human readable with nice visualisations.
## Building
```bash
git clone https://git.bune.city/lynnesbian/BunyMuny
cd BunyMuny
dotnet build
```
## The rules file
By default, BunyMuny checks for rules in `rules.json` in the current directory. An example rules file might look like this:
2020-09-27 03:06:44 +00:00
```csv
Match,Value,Category,Description,CaseSensitive
Start,Purchase Cash Converters,Personal,Cashies,true
2020-09-26 13:25:52 +00:00
```
2020-09-27 03:06:44 +00:00
This means that any statement that starts with "Purchase Cash Converters" (case sensitive) will be assigned the category "Personal", and the description "Cashies".
2020-09-26 13:25:52 +00:00
2020-09-27 03:06:44 +00:00
- `Match` specifies the type of matching to perform. It can be any of the following:
2020-09-26 13:25:52 +00:00
- "Start": Match the start of the description.
- "End": Match the end of the description.
- "Contains": Match anywhere in the description.
- "Exact": Only match if the bank statement's description is exactly equal to the provided value.
- "Regex": Match with [regular expressions](https://en.wikipedia.org/wiki/Regular_expression).
2020-09-27 03:06:44 +00:00
- `Value` specifies the value to match against.
- `Category` is the category that the statement should be filed under.
- `Description` is a short description to distinguish the particular merchant.
- `CaseSensitive` specifies whether or not the match should be case sensitive.