Featuretools is available for Python 3.7 and 3.8. The recommended way to install Featuretools is using
python -m pip install featuretools
or from the Conda-forge channel on anaconda.org:
conda install -c conda-forge featuretools
You can install add-ons individually or all at once by running:
python -m pip install "featuretools[complete]"
- Update checker:
Receive automatic notifications of new Featuretools releases:
python -m pip install "featuretools[update_checker]"
- NLP Primitives:
Use Natural Language Processing Primitives in Featuretools:
python -m pip install "featuretools[nlp_primitives]"
- TSFresh Primitives:
Use 60+ primitives from tsfresh in Featuretools:
python -m pip install "featuretools[tsfresh]"
pip install graphviz
conda install -c conda-forge python-graphviz
sudo apt install graphviz pip install graphviz
brew install graphviz pip install graphviz
Install according to your package manager:
# conda conda install -c conda-forge python-graphviz # pip pip install graphviz
If you installed graphviz with
pip, install graphviz.exe from the official source
Install from Source¶
To install featuretools from source, clone the repository from github:
git clone https://github.com/alteryx/featuretools.git cd featuretools python setup.py install
pip locally if you want to install all dependencies as well:
pip install .
You can view the list of all dependencies within the
Before making contributing to the codebase, please follow the guidelines here
We recommend developing in a virtualenv:
Install development requirements¶
In order to the run the featuretools tests you will need to have graphviz installed as described above.
Run featuretools tests:
Before committing make sure to run linting in order to pass CI:
Some linting errors can be automatically fixed by running the command below:
Build the docs with the commands below:
cd docs/ # small changes make html # rebuild from scatch make clean html
The Featuretools library must be import-able to build the docs.