Install Kedro¶
If you encounter any problems as you install Kedro, you can ask for help on Kedro’s Slack organisation or search the archives for a solution.
Installation prerequisites¶
Python¶
Kedro supports macOS, Linux, and Windows and is built for Python 3.7+.
To confirm that a valid version of Python is installed, type the following in your terminal (macOS and Linux):
python3 --version
On Windows, type the following into the command prompt:
python --version
You should see the version of Python installed on your machine:
Python 3.8.13
If you see an error message or need to install a later version of Python, you can download it from the official Python website.
git¶
You will need to install git onto your machine if you do not already have it. To check if it is installed:
git -v
You should see the version of git available or an error message if it is not installed. You can download it from the official git website.
Virtual environment manager¶
We suggest you create a new Python virtual environment for each new Kedro project you work on to isolate its dependencies from those of other projects. We strongly recommend installing conda if you don’t already use it.
Depending on your preferred Python installation, you can alternatively create virtual environments to work with Kedro using venv or pipenv instead of conda, as described in the FAQ
Create a new Python virtual environment using conda¶
To create a new virtual environment called kedro-environment using conda:
conda create --name kedro-environment python=3.10 -y
In this example, we use Python 3.10, but you can opt for a different version if you need it for your particular project.
To activate the new environment:
conda activate kedro-environment
Note
The conda virtual environment is not dependent on your current working directory and can be activated from any directory.
To exit kedro-environment:
conda deactivate
Install Kedro using pip or conda¶
To install Kedro from the Python Package Index (PyPI):
pip install kedro
Note
It is also possible to install Kedro using conda install -c conda-forge kedro, but we recommend you use pip at this point to eliminate any potential dependency issues:
Verify a successful installation¶
To check that Kedro is installed:
kedro info
You should see an ASCII art graphic and the Kedro version number: for example,
If you do not see the graphic displayed, or have any issues with your installation, see the frequently asked questions, check out the searchable archive from our retired Discord server, or post a new query on the Slack organisation.
Install a development version¶
To try out a development version of Kedro direct from the Kedro GitHub repository, follow these steps.