finance-tracker

Python tool to track finances over a year

PyPI - Python Version GitHub last commit

Installation

PyPi package

pip install finance-tracker

Usage

From repository

Clone the repo
Install poetry
Run make install
Set up the data as explained here
Run make run and enjoy!

From package installation

Follow the steps in Installation
Set up the data as explained here

Import it and use it in your project like this:

from finance_tracker.__main__ import run

if __name__ == "__main__":
    run()

Setting up the data

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"
  ]
}

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

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

Metadata

Release files for finance-tracker 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for finance-tracker 1.3.0
File	Size	Uploaded
finance_tracker-1.3.0.tar.gz	11.1 kB	Nov 25, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for finance-tracker 1.3.0
File	Interpreter	ABI	Platform	Reset
finance_tracker-1.3.0-py3-none-any.whl 15.1 kB Nov 25, 2022	Python 3	none	any	Details

Total release size: 26.2 kB

Release files / finance_tracker-1.3.0.tar.gz

Download URL	finance_tracker-1.3.0.tar.gz
Size	11.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`2bfa606da8271df167e57d513fda4ff80e34cd86b05db3cbbb42d5c94924d741`
BLAKE2b-256 checksum How to use checksums	`a7024f4a479708020f95ffa037f64b8af274181240732154e87c78b32033ca20`
Upload date	Nov 25, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.9.15`

Release files / finance_tracker-1.3.0-py3-none-any.whl

Download URL	finance_tracker-1.3.0-py3-none-any.whl
Size	15.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1d89bd0732b3eafa682a5fb361b4f1a3af4c92d7efe933dbcaf541bf187e0add`
BLAKE2b-256 checksum How to use checksums	`b25924ec3cecae1363cacd7ba95bdc862613b5c26772763237bdbe409f852fa1`
Upload date	Nov 25, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.9.15`