Skip to content

Commit

Permalink
Turn default template into src-layout Python package
Browse files Browse the repository at this point in the history
Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
  • Loading branch information
astrojuanlu committed Jun 20, 2023
1 parent 8d0be99 commit 8713706
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions kedro/templates/project/{{ cookiecutter.repo_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ In order to get the best out of the template:

## How to install dependencies

Declare any dependencies in `src/requirements.txt` for `pip` installation and `src/environment.yml` for `conda` installation.
Declare any dependencies in `requirements.txt` for `pip` installation and `environment.yml` for `conda` installation.

To install them, run:

```
pip install -r src/requirements.txt
pip install -r requirements.txt
```

## How to run your Kedro pipeline
Expand All @@ -35,7 +35,7 @@ kedro run

## How to test your Kedro project

Have a look at the file `src/tests/test_run.py` for instructions on how to write your tests. You can run your tests as follows:
Have a look at the file `tests/test_run.py` for instructions on how to write your tests. You can run your tests as follows:

```
kedro test
Expand All @@ -51,17 +51,17 @@ To generate or update the dependency requirements for your project:
kedro build-reqs
```

This will `pip-compile` the contents of `src/requirements.txt` into a new file `src/requirements.lock`. You can see the output of the resolution by opening `src/requirements.lock`.
This will `pip-compile` the contents of `requirements.txt` into a new file `requirements.lock`. You can see the output of the resolution by opening `requirements.lock`.

After this, if you'd like to update your project requirements, please update `src/requirements.txt` and re-run `kedro build-reqs`.
After this, if you'd like to update your project requirements, please update `requirements.txt` and re-run `kedro build-reqs`.

[Further information about project dependencies](https://docs.kedro.org/en/stable/kedro_project_setup/dependencies.html#project-specific-dependencies)

## How to work with Kedro and notebooks

> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `context`, `catalog`, and `startup_error`.
>
> Jupyter, JupyterLab, and IPython are already included in the project requirements by default, so once you have run `pip install -r src/requirements.txt` you will not need to take any extra steps before you use them.
> Jupyter, JupyterLab, and IPython are already included in the project requirements by default, so once you have run `pip install -r requirements.txt` you will not need to take any extra steps before you use them.
### Jupyter
To use Jupyter notebooks in your Kedro project, you need to install Jupyter:
Expand Down

0 comments on commit 8713706

Please sign in to comment.