Update all readmes

databricks-iris/README.md

@@ -4,7 +4,7 @@
 
 The code in this repository demonstrates best practice when working with Kedro and PySpark on Databricks. It contains a Kedro starter template with some initial configuration and an example pipeline, it accompanies the documentation on [developing and deploying Kedro projects on Databricks](https://docs.kedro.org/en/stable/deployment/databricks/index.html).
 
-This repository is a fork of the `pyspark-iris` starter that has been modified to run natively on Databricks.
+This starter contains a project created with example code based on the familiar [Iris dataset](https://www.kaggle.com/datasets/uciml/iris).
 
 ## Getting started
 

spaceflights-pandas-viz/README.md

@@ -2,23 +2,19 @@
 
 ## Overview
 
-This is a completed version of the [spaceflights tutorial project](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) described in the [online Kedro documentation](https://docs.kedro.org) and the extra tutorial sections on [visualisation with Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html) and [experiment tracking with Kedro-Viz](https://docs.kedro.org/en/stable/experiment_tracking/index.html). This project includes the data required to run it.
+This is a completed version of the [spaceflights tutorial project](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) described in the [online Kedro documentation](https://docs.kedro.org) and the extra tutorial sections on [visualisation with Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html) and [experiment tracking with Kedro-Viz](https://docs.kedro.org/en/stable/experiment_tracking/index.html). It includes the data required to run the project. 
 
-The tutorial works through the steps necessary to create this project. To learn the most about Kedro, we recommend that you start with a blank template as the tutorial describes, and follow the workflow. However, if you prefer to read swiftly through the documentation and get to work on the code, you may want to generate a new Kedro project using this [starter](https://docs.kedro.org/en/stable/kedro_project_setup/starters.html) because the steps have been done for you.
-
-To use this starter, create a new Kedro project using the commands below. To make sure you have the required dependencies, run it in your virtual environment (see [our documentation about virtual environments](https://docs.kedro.org/en/stable/get_started/install.html#virtual-environments) for guidance on how to get set up):
+To create a project based on this starter, [ensure you have installed Kedro into a virtual environment](https://docs.kedro.org/en/stable/get_started/install.html). Then use the following command:
 
 ```bash
 pip install kedro
 kedro new --starter=spaceflights-pandas-viz
-cd <my-project-name>  # change directory into newly created project directory
 ```
 
-This will give you the complete project and project template. If you would prefer to have a reduced project template you can use `add-ons` instead and select `Kedro-Viz` as add-on with an example:
+After the project is created, navigate to the newly created project directory:
+
 ```bash
-pip install kedro
-kedro new --add-ons=XXX
-cd <my-project-name>  # change directory into newly created project directory
+cd <my-project-name>  # change directory 
 ```
 
 Install the required dependencies:
@@ -41,3 +37,4 @@ kedro viz
 This will open the default browser and display the following pipeline visualisation:
 
 ![](./images/pipeline_visualisation_with_layers.png)
+

spaceflights-pandas-viz/{{ cookiecutter.repo_name }}/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-This is your new Kedro project, which was generated using `kedro {{ cookiecutter.kedro_version }}`.
+This is your new Kedro project for the [spaceflights tutorial](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) and the extra tutorial sections on [visualisation with Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html) and [experiment tracking with Kedro-Viz](https://docs.kedro.org/en/stable/experiment_tracking/index.html), which was generated using `kedro {{ cookiecutter.kedro_version }}`.
 
 Take a look at the [Kedro documentation](https://docs.kedro.org) to get started.
 
@@ -32,3 +32,68 @@ You can run your Kedro project with:
 ```
 kedro run
 ```
+
+## How to test your Kedro project
+
+Have a look at the files `src/tests/test_run.py` and `src/tests/pipelines/test_data_science.py` for instructions on how to write your tests. You can run your tests as follows:
+
+```
+pytest
+```
+
+To configure the coverage threshold, look at the `.coveragerc` file.
+
+## Project dependencies
+
+To see and update the dependency requirements for your project use `requirements.txt`. You can install the project requirements with `pip install -r requirements.txt`.
+
+[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: `catalog`, `context`, `pipelines` and `session`.
+>
+> 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:
+
+```
+pip install jupyter
+```
+
+After installing Jupyter, you can start a local notebook server:
+
+```
+kedro jupyter notebook
+```
+
+### JupyterLab
+To use JupyterLab, you need to install it:
+
+```
+pip install jupyterlab
+```
+
+You can also start JupyterLab:
+
+```
+kedro jupyter lab
+```
+
+### IPython
+And if you want to run an IPython session:
+
+```
+kedro ipython
+```
+
+### How to ignore notebook output cells in `git`
+To automatically strip out all output cell contents before committing to `git`, you can use tools like [`nbstripout`](https://github.com/kynan/nbstripout). For example, you can add a hook in `.git/config` with `nbstripout --install`. This will run `nbstripout` before anything is committed to `git`.
+
+> *Note:* Your output cells will be retained locally.
+
+[Further information about using notebooks for experiments within Kedro projects](https://docs.kedro.org/en/develop/notebooks_and_ipython/kedro_and_notebooks.html).
+## Package your Kedro project
+
+[Further information about building project documentation and packaging your project](https://docs.kedro.org/en/stable/tutorial/package_a_project.html).

spaceflights-pandas-viz/{{ cookiecutter.repo_name }}/conf/README.md

@@ -16,7 +16,5 @@ The `base` folder is for shared configuration, such as non-sensitive and project
 
 WARNING: Please do not put access credentials in the base configuration folder.
 
-## Instructions
-
 ## Find out more
 You can find out more about configuration from the [user guide documentation](https://docs.kedro.org/en/stable/configuration/configuration_basics.html).

spaceflights-pandas-viz/{{ cookiecutter.repo_name }}/conf/base/catalog.yml

@@ -51,7 +51,7 @@ shuttles:
   type: pandas.ExcelDataset
   filepath: data/01_raw/shuttles.xlsx
   load_args:
-    engine: openpyxl # Use modern Excel engine, it is the default since Kedro 0.18.0
+    engine: openpyxl
 
 preprocessed_companies:
   type: pandas.ParquetDataset

spaceflights-pandas/README.md

@@ -2,16 +2,19 @@
 
 ## Overview
 
-This is a completed version of the [spaceflights tutorial project](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) described in the [online Kedro documentation](https://docs.kedro.org), including the data required to run the project.
+This is a completed version of the [spaceflights tutorial project](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) described in the [online Kedro documentation](https://docs.kedro.org), including the data required to run the project. 
 
-The tutorial works through the steps necessary to create this project. To learn the most about Kedro, we recommend that you start with a blank template as the tutorial describes, and follow the workflow. However, if you prefer to read swiftly through the documentation and get to work on the code, you may want to generate a new Kedro project using this [starter](https://docs.kedro.org/en/stable/kedro_project_setup/starters.html) because the steps have been done for you.
-
-To use this starter, create a new Kedro project using the commands below. To make sure you have the required dependencies, run it in your virtual environment (see [our documentation about virtual environments](https://docs.kedro.org/en/stable/get_started/install.html#virtual-environments) for guidance on how to get set up):
+To create a project based on this starter, [ensure you have installed Kedro into a virtual environment](https://docs.kedro.org/en/stable/get_started/install.html). Then use the following command:
 
 ```bash
 pip install kedro
 kedro new --starter=spaceflights-pandas
-cd <my-project-name>  # change directory into newly created project directory
+```
+
+After the project is created, navigate to the newly created project directory:
+
+```bash
+cd <my-project-name>  # change directory 
 ```
 
 Install the required dependencies:
@@ -34,3 +37,4 @@ kedro viz
 This will open the default browser and display the following pipeline visualisation:
 
 ![](./images/pipeline_visualisation_with_layers.png)
+

spaceflights-pandas/{{ cookiecutter.repo_name }}/README.md

@@ -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 files `src/tests/test_run.py` and `src/tests/pipelines/test_data_science.py` for instructions on how to write your tests. You can run your tests as follows:
 
 ```
 pytest

spaceflights-pandas/{{ cookiecutter.repo_name }}/conf/README.md

@@ -16,11 +16,5 @@ The `base` folder is for shared configuration, such as non-sensitive and project
 
 WARNING: Please do not put access credentials in the base configuration folder.
 
-## Instructions
-
-
-
-
-
 ## Find out more
 You can find out more about configuration from the [user guide documentation](https://docs.kedro.org/en/stable/configuration/configuration_basics.html).

spaceflights-pandas/{{ cookiecutter.repo_name }}/conf/base/catalog.yml

@@ -51,7 +51,7 @@ shuttles:
   type: pandas.ExcelDataset
   filepath: data/01_raw/shuttles.xlsx
   load_args:
-    engine: openpyxl # Use modern Excel engine, it is the default since Kedro 0.18.0
+    engine: openpyxl
 
 preprocessed_companies:
   type: pandas.ParquetDataset

spaceflights-pyspark-viz/README.md

@@ -2,16 +2,20 @@
 
 ## Overview
 
-This is a variation of the [spaceflights tutorial project](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) described in the [online Kedro documentation](https://docs.kedro.org) with `PySpark` and `Kedro-Viz` setup.
+This is a completed version of the [spaceflights tutorial project](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) and the extra tutorial sections on [visualisation with Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html) and [experiment tracking with Kedro-Viz](https://docs.kedro.org/en/stable/experiment_tracking/index.html) with PySpark setup that originates from the [Kedro documentation about how to work with PySpark](https://docs.kedro.org/en/stable/integrations/pyspark_integration.html). 
+This project includes the data required to run it. The code in this repository demonstrates best practice when working with Kedro and PySpark.
 
-The code in this repository demonstrates best practice when working with Kedro and PySpark. It contains a Kedro starter template with some initial configuration and two example pipelines, and originates from the [Kedro documentation about how to work with PySpark](https://docs.kedro.org/en/stable/integrations/pyspark_integration.html).
-
-To use this starter, create a new Kedro project and select `pyspark` and `Kedro-Viz` as add-ons.
+To create a project based on this starter, [ensure you have installed Kedro into a virtual environment](https://docs.kedro.org/en/stable/get_started/install.html). Then use the following command:
 
 ```bash
 pip install kedro
-kedro new
-cd <my-project-name>  # change directory into newly created project directory
+kedro new --starter=spaceflights-pyspark-viz
+```
+
+After the project is created, navigate to the newly created project directory:
+
+```bash
+cd <my-project-name>  # change directory 
 ```
 
 Install the required dependencies:

spaceflights-pyspark-viz/{{ cookiecutter.repo_name }}/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-This is your new Kedro project, which was generated using `kedro {{ cookiecutter.kedro_version }}`.
+This is your new Kedro project for the [spaceflights tutorial](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) and the extra tutorial sections on [visualisation with Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html) and [experiment tracking with Kedro-Viz](https://docs.kedro.org/en/stable/experiment_tracking/index.html) with PySpark setup, which was generated using `kedro {{ cookiecutter.kedro_version }}`.
 
 Take a look at the [Kedro documentation](https://docs.kedro.org) to get started.
 
@@ -32,3 +32,67 @@ You can run your Kedro project with:
 ```
 kedro run
 ```
+
+## How to test your Kedro project
+
+Have a look at the files `src/tests/test_run.py` and `src/tests/pipelines/test_data_science.py` for instructions on how to write your tests. You can run your tests as follows:
+
+```
+pytest
+```
+
+To configure the coverage threshold, look at the `.coveragerc` file.
+
+## Project dependencies
+
+To see and update the dependency requirements for your project use `requirements.txt`. You can install the project requirements with `pip install -r requirements.txt`.
+
+[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: `catalog`, `context`, `pipelines` and `session`.
+>
+> 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:
+
+```
+pip install jupyter
+```
+
+After installing Jupyter, you can start a local notebook server:
+
+```
+kedro jupyter notebook
+```
+
+### JupyterLab
+To use JupyterLab, you need to install it:
+
+```
+pip install jupyterlab
+```
+
+You can also start JupyterLab:
+
+```
+kedro jupyter lab
+```
+
+### IPython
+And if you want to run an IPython session:
+
+```
+kedro ipython
+```
+
+### How to ignore notebook output cells in `git`
+To automatically strip out all output cell contents before committing to `git`, you can use tools like [`nbstripout`](https://github.com/kynan/nbstripout). For example, you can add a hook in `.git/config` with `nbstripout --install`. This will run `nbstripout` before anything is committed to `git`.
+
+> *Note:* Your output cells will be retained locally.
+
+## Package your Kedro project
+
+[Further information about building project documentation and packaging your project](https://docs.kedro.org/en/stable/tutorial/package_a_project.html)

spaceflights-pyspark/README.md

@@ -6,12 +6,17 @@ This is a variation of the [spaceflights tutorial project](https://docs.kedro.or
 
 The code in this repository demonstrates best practice when working with Kedro and PySpark. It contains a Kedro starter template with some initial configuration and two example pipelines, and originates from the [Kedro documentation about how to work with PySpark](https://docs.kedro.org/en/stable/integrations/pyspark_integration.html).
 
-To use this starter, create a new Kedro project and select `pyspark` as add-on.
+To create a project based on this starter, [ensure you have installed Kedro into a virtual environment](https://docs.kedro.org/en/stable/get_started/install.html). Then use the following command:
 
 ```bash
 pip install kedro
-kedro new
-cd <my-project-name>  # change directory into newly created project directory
+kedro new --starter=spaceflights-pyspark
+```
+
+After the project is created, navigate to the newly created project directory:
+
+```bash
+cd <my-project-name>  # change directory 
 ```
 
 Install the required dependencies:

spaceflights-pyspark/{{ cookiecutter.repo_name }}/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-This is your new Kedro project, which was generated using `kedro {{ cookiecutter.kedro_version }}`.
+This is your new Kedro project for the [spaceflights tutorial](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) with PySpark setup, which was generated using `kedro {{ cookiecutter.kedro_version }}`.
 
 Take a look at the [Kedro documentation](https://docs.kedro.org) to get started.
 
@@ -32,3 +32,67 @@ You can run your Kedro project with:
 ```
 kedro run
 ```
+
+## How to test your Kedro project
+
+Have a look at the files `src/tests/test_run.py` and `src/tests/pipelines/test_data_science.py` for instructions on how to write your tests. You can run your tests as follows:
+
+```
+pytest
+```
+
+To configure the coverage threshold, look at the `.coveragerc` file.
+
+## Project dependencies
+
+To see and update the dependency requirements for your project use `requirements.txt`. You can install the project requirements with `pip install -r requirements.txt`.
+
+[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: `catalog`, `context`, `pipelines` and `session`.
+>
+> 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:
+
+```
+pip install jupyter
+```
+
+After installing Jupyter, you can start a local notebook server:
+
+```
+kedro jupyter notebook
+```
+
+### JupyterLab
+To use JupyterLab, you need to install it:
+
+```
+pip install jupyterlab
+```
+
+You can also start JupyterLab:
+
+```
+kedro jupyter lab
+```
+
+### IPython
+And if you want to run an IPython session:
+
+```
+kedro ipython
+```
+
+### How to ignore notebook output cells in `git`
+To automatically strip out all output cell contents before committing to `git`, you can use tools like [`nbstripout`](https://github.com/kynan/nbstripout). For example, you can add a hook in `.git/config` with `nbstripout --install`. This will run `nbstripout` before anything is committed to `git`.
+
+> *Note:* Your output cells will be retained locally.
+
+## Package your Kedro project
+
+[Further information about building project documentation and packaging your project](https://docs.kedro.org/en/stable/tutorial/package_a_project.html)