Set up the spaceflights project

In this section, we discuss the project set-up phase, which is the first part of the standard development workflow. The set-up steps are as follows:

  • Create a new project
  • Install dependencies
  • Configure the project

Create a new project

Navigate to your chosen working directory and run the following to create a new project using the interactive prompts:

kedro new

Feel free to name your project as you like, but this guide will assume the project is named Kedro Tutorial.

Keep the default names for the repo_name and python_package when prompted.

Choose N at the final prompt, so you create a project template without the Iris dataset example.

Install project dependencies

Up to this point, we haven’t discussed project dependencies, so now is a good time to introduce them. Specifying a project’s dependencies in Kedro makes it easier for others to run your project; it avoids version conflicts by use of the same Python packages.

The generic project template bundles some typical dependencies, in src/requirements.txt.

black==v19.10b0 # Used for formatting code with `kedro lint`
flake8>=3.7.9, <4.0 # Used for linting code with `kedro lint`
ipython>=7.0.0, <8.0 # Used for an IPython session with `kedro ipython`
isort>=4.3.21, <5.0 # Used for linting code with `kedro lint`
jupyter>=1.0.0, <2.0 # Used to open a Kedro-session in Jupyter Notebook & Lab
jupyter_client>=5.1.0, <6.0 # Used to open a Kedro-session in Jupyter Notebook & Lab
jupyterlab==0.31.1 # Used to open a Kedro-session in Jupyter Lab
kedro==0.16.3
nbstripout==0.3.3 # Strips the output of a Jupyter Notebook and writes the outputless version to the original file
pytest-cov>=2.5, <3.0 # Produces test coverage reports
pytest-mock>=1.7.1,<2.0 # Wrapper around the mock package for easier use with pytest
pytest>=3.4, <4.0 # Testing framework for Python code
wheel==0.32.2 # The reference implementation of the Python wheel packaging standard

These dependencies may be sufficient for your project, in which case you can move to the next section and use kedro install.

Note: If your project has conda dependencies, you can create a src/environment.yml file and list them there.

Add and remove project-specific dependencies

If you need to, you can add or remove dependencies. For a new project, edit src/requirements.txt and then run the following:

kedro build-reqs

kedro install

To install the project-specific dependencies, navigate to the root directory of the project and run:

kedro install

You can find further information in our advanced documentation about working with dependencies.

Configure the project

You need to configure the credentials within your project’s conf folder:

  • Move credentials.yml from conf/base/ to conf/local/. To do this in the terminal, type the following from within the project’s root directory:
mv conf/base/credentials.yml conf/local/
  • You may optionally add in any credentials to conf/local/credentials.yml that you would need to load specific data sources like usernames and passwords. Some examples are given within the file to illustrate how you store credentials. Additional information can be found in the advanced documentation on configuration.

At this stage of the workflow, you may also want to set up logging, but we do not use it in this tutorial.