Create a new project

Once you have installed Kedro, you can create a new project by answering a series of questions, or by using settings recorded in a configuration file.

Create a new project interactively

Create a new project in your current working directory:

kedro new

You will be asked to enter each of the following variables in turn. Once you have entered text for the first option (the project’s name), you will be offered a default choice for the other options:

Option Example Description
project_name Get Started A human-readable name for your new project
repo_name get-started Directory that holds your project repository
python_package get_started A name for the Python package name in your project (short, all-lowercase)
include_example Y/n Confirms or rejects the inclusion of the Iris example code Your new project template contains a small example if you enter Y

The output lists the directory in which to find the project.

Create a new project from a configuration file

You can create a new project from a configuration file if you prefer. The file must contain:

  • output_dir The path in which to create the project directory
  • project_name
  • repo_name
  • python_package
  • include_example (Boolean value) option to confirm or reject the inclusion of the Iris example code

The output_dir can be set to wherever you want to create the project. For example, ~ for your home directory, or . for the current working directory. Here is an example config.yml, which assumes that a directory named ~/code already exists:

output_dir: ~/code
project_name: Get Started
repo_name: get-started
python_package: get_started
include_example: true

To create the new project:

kedro new --config config.yml

Initialise a git repository

Having created your new project, if you are using git, you may want to set up a new repository by calling:

git init

Create a new project using starters

Kedro supports using custom starter templates to create your project via the --starter flag. To learn more about this feature, please read the guide to creating new projects with Kedro Starters.