Install

Pip

The recommended way to install Featuretool is with pip

pip install featuretools

Note

Featuretools currently only supports Python 2.7. Check back in the near future for Python 3 support

Install from Source

To install featuretools from source, clone the repository from github:

git clone https://github.com/featuretools/featuretools.git
cd featuretools
python setup.py install

or use pip locally if you want to install all dependencies as well:

pip install .

You can view the list of all dependencies within the extras_require field of setup.py.

Development

Virtualenv

We recommend developing in a virtualenv:

mkvirtualenv featuretools

Install development requirements

Run:

make installdeps

Test

Run featuretools tests:

make test

Build Documentation

Build the docs with the commands below:

cd docs/

# small changes
make html

# rebuild from scatch
make clean html

Note

The Featuretools library must be import-able to build the docs.