finance-tracker 1.3.0

Python tool to track finances over a year

finance-tracker

Python tool to track finances over a year

Installation

PyPi package

pip install finance-tracker

Usage

From repository

1. Clone the repo
2. Install poetry
3. Run make install
4. Set up the data as explained here
5. Run make run and enjoy!

From package installation

1. Follow the steps in Installation
2. Set up the data as explained here
3. Import it and use it in your project like this:

   from finance_tracker.__main__ import run
   
   if __name__ == "__main__":
       run()
   

Setting up the data

1. Load the categories and categories to filter as incomes wanted in a file called categories.json in ./load/categories/. Such as:

   {
     "CATEGORIES": {
       "CATEGORY_ONE": [
         "TITLE TO CATEGORIZE"
       ],
       "CATEGORY_TWO": [
         "TITLE 2 TO CATEGORIZE"
       ]
     },
     "POSITIVE_CATEGORIES": [
       "CATEGORY_TWO"
     ]
   }
   

2. Load your CSV files according to your bank under ./load/entries_files/{bank} according to your bank. See Banks Supported.

3. Load any other CSV files in the folder ./load/entries_files/. By default, those files will have this format:

   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
   

Banks supported

Any other bank needs to be implemented or follow the current default CSV

• Revolut

Contributing

Pull requests are welcome. Issues are welcome too.

Please make sure to update tests as appropriate.

License

MIT