Skip to content

Commit

Permalink
Improve usage instructions (#51)
Browse files Browse the repository at this point in the history
Co-authored-by: Ramon
  • Loading branch information
w0rmr1d3r committed Nov 25, 2022
1 parent 3771dcd commit 7811cfa
Showing 1 changed file with 15 additions and 40 deletions.
55 changes: 15 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,41 +26,24 @@ pip install finance-tracker
1. Clone the repo
2. Install [poetry](https://python-poetry.org)
3. Run `make install`
4. Load the categories and categories to filter as incomes wanted in a file called `categories.json`
in `./load/categories/`. Such as:
```json
{
"CATEGORIES": {
"CATEGORY_ONE": [
"TITLE TO CATEGORIZE"
],
"CATEGORY_TWO": [
"TITLE 2 TO CATEGORIZE"
]
},
"POSITIVE_CATEGORIES": [
"CATEGORY_TWO"
]
}
```
4. Set up the data as explained [here](#setting-up-the-data)
5. Run `make run` and enjoy!

5. Load your CSV files according to your bank under `./load/entries_files/{bank}` according to your bank.
See [Banks Supported](#banks-supported).
### From package installation

6. Load any other CSV files in the folder `./load/entries_files/`. By default, those files will have this format:
```csv
HEADER1;;;;;
HEADER2;;;;;
DATE;DATE TWO;TITLE;OTHER DATA;QUANTITY;OTHER
01/01/1999;01/01/1999;PAYCHECK;PAYCHECK FROM COMPANY 1;1.000;1.000
1. Follow the steps in [Installation](#installation)
2. Set up the data as explained [here](#setting-up-the-data)
3. Import it and use it in your project like this:
```python
from finance_tracker.__main__ import run

if __name__ == "__main__":
run()
```

7. Run `make run` and enjoy!
## Setting up the data

### From package installation

1. Follow the steps in [Installation](#installation)
2. Load the categories and categories to filter as incomes wanted in a file called `categories.json`
1. Load the categories and categories to filter as incomes wanted in a file called `categories.json`
in `./load/categories/`. Such as:
```json
{
Expand All @@ -78,25 +61,17 @@ pip install finance-tracker
}
```

3. Load your CSV files according to your bank under `./load/entries_files/{bank}` according to your bank.
2. Load your CSV files according to your bank under `./load/entries_files/{bank}` according to your bank.
See [Banks Supported](#banks-supported).

4. Load any other CSV files in the folder `./load/entries_files/`. By default, those files will have this format:
3. Load any other CSV files in the folder `./load/entries_files/`. By default, those files will have this format:
```csv
HEADER1;;;;;
HEADER2;;;;;
DATE;DATE TWO;TITLE;OTHER DATA;QUANTITY;OTHER
01/01/1999;01/01/1999;PAYCHECK;PAYCHECK FROM COMPANY 1;1.000;1.000
```

5. Import it and use it in your project like this:
```python
from finance_tracker.__main__ import run

if __name__ == "__main__":
run()
```

## Banks supported

_Any other bank needs to be implemented or follow the current default CSV_
Expand Down

0 comments on commit 7811cfa

Please sign in to comment.