Turn default template into src-layout Python package

Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
kedro-org · May 17, 2023 · 94a7683 · 94a7683
1 parent 328a3df
commit 94a7683
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md b/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md
@@ -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
@@ -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
@@ -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:

diff --git a/...ecutter.repo_name }}/src/requirements.txt → ...ookiecutter.repo_name }}/requirements.txt b/...ecutter.repo_name }}/src/requirements.txt → ...ookiecutter.repo_name }}/requirements.txt
diff --git a/...{{ cookiecutter.repo_name }}/src/setup.py → ...ect/{{ cookiecutter.repo_name }}/setup.py b/...{{ cookiecutter.repo_name }}/src/setup.py → ...ect/{{ cookiecutter.repo_name }}/setup.py
diff --git a/...cutter.repo_name }}/src/tests/__init__.py → ...okiecutter.repo_name }}/tests/__init__.py b/...cutter.repo_name }}/src/tests/__init__.py → ...okiecutter.repo_name }}/tests/__init__.py
diff --git a/...o_name }}/src/tests/pipelines/__init__.py → ....repo_name }}/tests/pipelines/__init__.py b/...o_name }}/src/tests/pipelines/__init__.py → ....repo_name }}/tests/pipelines/__init__.py
diff --git a/...cutter.repo_name }}/src/tests/test_run.py → ...okiecutter.repo_name }}/tests/test_run.py b/...cutter.repo_name }}/src/tests/test_run.py → ...okiecutter.repo_name }}/tests/test_run.py