Installation

The easiest way to install ProjectPredict is to install it from PyPI using pip

pip install projectpredict

Or, using Pipenv, the new officially recommended standard for Python package management,

Development Installation

Currently the only way to install ProjectPredict for development is to clone it from GitHub.

git clone https://github.com/JustinTervala/ProjectPredict

Set up your virtual environment using virtualenv

git clone https://github.com/JustinTervala/ProjectPredict
cd ProjectPredict
virtualenv venv
source venv/bin/activate

Then install the requirements

pip install -r requirements.txt
pip install -r requirements-dev.txt

Or, using Pipenv

git clone https://github.com/JustinTervala/ProjectPredict
cd ProjectPredict
pipenv install --dev
pipenv shell

Testing

ProjectPredict uses pytest as its unit testing framework. You can run the tests from the top-level directory by simply typing “pytest”

pytest --cov=projectpredict

Building the Documentation

ProjectPredict uses sphinx to build the docs, and uses several plugins. From the top-level directory,

cd docs
pip install -r requirements.txt
make html

This will generate the file in docs/_build/index.html. This file is the entry point to the documentation