Woodwork is available for Python 3.7, 3.8, and 3.9. It can be installed from PyPI, conda, or from source.
To install Woodwork from PyPI, run the following command:
python -m pip install woodwork
Woodwork allows users to install add-ons individually or all at once. In order to install all add-ons, run:
python -m pip install "woodwork[complete]"
You can use Woodwork with Dask DataFrames by running:
python -m pip install "woodwork[dask]"
You can use Woodwork with Koalas DataFrames by running:
python -m pip install "woodwork[koalas]"
To install Woodwork from conda run the following command:
conda install -c conda-forge woodwork
In order to use Woodwork with Dask or Koalas DataFrames, the following commands must be run for your library of choice prior to installing Woodwork with conda: conda install dask for Dask or conda install koalas and conda install pyspark for Koalas.
conda install dask
conda install koalas
conda install pyspark
To install Woodwork from source, clone the repository from Github, and install the dependencies.
git clone https://github.com/alteryx/woodwork.git
python -m pip install .
You can view a list of all Woodwork core dependencies in the requirements.txt file.
Woodwork has several other dependencies that are used only for specific methods. Attempting to use one of these methods without having the necessary library installed will result in an ImportError with instructions on how to install the necessary dependency.
Required to read/write to URLs and S3
Required to serialize to parquet
Required to use with Dask DataFrames
Required to use with Koalas DataFrames
To make contributions to the codebase, please follow the guidelines here.