Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the project template README.md #3387

Merged
merged 2 commits into from
Dec 5, 2023
Merged

Update the project template README.md #3387

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3745af
Update template README
ankatiyar Dec 4, 2023
3ca741a
Update coverage section
ankatiyar Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions kedro/templates/project/{{ cookiecutter.repo_name }}/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Have a look at the file `src/tests/test_run.py` for instructions on how to write
pytest
```

To configure the coverage threshold, look at the `.coveragerc` file.
You can configure the coverage threshold in your project's `pyproject.toml` file under the `[tool.coverage.report]` section.


## Project dependencies
Expand All @@ -52,7 +52,7 @@ To see and update the dependency requirements for your project use `requirements

## 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`.
> Note: Using `kedro jupyter` or `kedro ipython` to run your notebook provides these variables in scope: `context`, 'session', `catalog`, and `pipelines`.
>
> 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.

Expand Down