Installation

Via pip python package manager...

The simplest way to install the library is through the pip python package manager, all the dependencies are automatically installed for you.

pip install scikit-portfolio

...or from source via the scikit-portfolio repository

Scikit-portfolio is an open source portfolio management library, whose code is hosted on github.com/carlonicolini/scikit-portfolio. We reccomend you install on a virtual envinronment. If you are on Mac/Linux, the make sure to have virtualenv installed.

  1. Download the latest version of scikit-portfolio from public repository:
git clone https://github.com/carlonicolini/scikit-portfolio.git
  1. Enter downloaded directory
cd scikitportfolio
  1. Create and activate a virtual envinronment named venv:
virtualenv venv
source venv/bin/activate
  1. Either select the stable version:
git checkout master
  1. or, if you are a developer, switch to the development branch, where you can send pull requests: 
git checkout develop
  1. Then install the library with pip.
pip install .
  1. To run all tests, you need to have pytest* installed. For this you need the requirements_dev packages:
pip install -r requirements_dev.txt

then run tox

make test