Repository files navigation

PerFin is a Personal Finance library for Python

It's basically a wrapper library for Pandas and Zipline with the focus on an easy to use interface

• Load and handle csv files
• Calculate montly savings and outliers
• Get aggregates for easy analytics
• Support to model simple stock portfolios and doing weight analysis on them.

PerFin, more specificcvxopt requires theumfpack.h header file.On Mac you can easily install it via brew, see the following link:Scientific packages for Python3

• Will add a simple API for backtesting, plotting in Jupyter, monte carlo simulations ... over the next month

Please have a look at theexamples directory for all examples.

To get a PerFin playground execute the following steps

1. Define a environment variable 'PERFIN_FILES' and point it to the directory with the csv files you want to work on

• on MacOS or Linux it's

  export PERFIN_FILES=/home/user/files

• Note: Right now, if you have on folder for all.csv files, they willall be put together into one dataframe, regardless if the filenames say 'checking' or 'saving'.

2. Open the interpreter in thePerFin folder. Load the playground script from the examples folder.

• Option 1: Import the playground module. The code is directly executed and is then available viaplayground.data
• Option 2: Add the variables to the interpreters global scope e.g.

  exec(open("/Users/admin/pythonprojects/perfin/examples/playground.py").read(),globals())

3. Have fun