Installation prerequisites¶
Kedro supports macOS, Linux and Windows (7 / 8 / 10 and Windows Server 2016+). If you encounter any problems on these platforms, please check the FAQ, and / or the Kedro community support on Stack Overflow.
macOS / Linux¶
In order to work effectively with Kedro projects, we highly recommend you download and install Anaconda (Python 3.x version) and Java (if using PySpark).
Working with virtual environments¶
The main purpose of Python virtual environments is to create an isolated environment for Python projects. This means that each project can have its own dependencies, regardless of what dependencies every other project has. Read more about Python Virtual Environments here.
Follow the instructions that best suit your Python installation preference from below:
conda
environment with Python 3.7venv
orpipenv
used when you prefer not to useconda
and instead use your global Python interpreter.
conda
¶
Follow this guide to install conda
on your computer. Once it’s done, you can create a new Python virtual environment using conda
:
conda create --name kedro-environment python=3.7 -y
This will create an isolated Python 3.7 environment. To activate it:
conda activate kedro-environment
To exit the environment:
conda deactivate kedro-environment
Note: Unlikevenv
orpipenv
,conda
virtual environment is not dependent on your current working directory and can be activated from anywhere.
venv
(instead of conda
)¶
If you are using Python 3, then you should already have the venv
module installed with the standard library. However, for completeness you can install venv
:
pip install virtualenv
Create a directory for your virtual environment:
mkdir kedro-environment && cd kedro-environment
This will create a kedro-environment
directory in your current working directory. Then you should create a new virtual environment in this directory by running:
python -m venv env/kedro-environment # macOS / Linux
python -m venv env\kedro-environment # Windows
We can activate this virtual environment with:
source env/kedro-environment/bin/activate # macOS / Linux
.\env\kedro-environment\Scripts\activate # Windows
To exit the environment:
deactivate
pipenv
(instead of conda
)¶
You will need to install pipenv
with:
pip install pipenv
Then create a directory for the virtual environment and change to this working directory:
mkdir kedro-environment && cd kedro-environment
Once all the dependencies are installed you can run pipenv shell
which will start a session with the correct virtual environment activated.
To exit the shell session:
exit