Install¶

Woodwork is available for Python 3.6, 3.7, and 3.8. The recommended way to install woodwork is using pip:

python -m pip install woodwork

Install from Source¶

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

git clone https://github.com/FeatureLabs/woodwork.git
cd woodwork
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.

Before making contributions to the codebase, please follow the guidelines here.

We recommend developing in a virtualenv:

mkvirtualenv venv

Run:

make installdeps

Run Woodwork tests:

make test

Before committing make sure to run linting in order to pass CI:

make lint

Some linting errors can be automatically fixed by running the command below:

make lint-fix

Build the docs with the commands below:

cd docs/

# small changes
make html

# rebuild from scatch
make clean html