Turn default template into src-layout Python package

Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>
kedro-org · Sep 25, 2023 · a1f0426 · a1f0426
1 parent 94f26f2
commit a1f0426
Show file tree

Hide file tree

Showing 11 changed files with 73 additions and 67 deletions.
diff --git a/features/steps/test_starter/{{ cookiecutter.repo_name }}/pyproject.toml b/features/steps/test_starter/{{ cookiecutter.repo_name }}/pyproject.toml
@@ -1,7 +1,41 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{{ cookiecutter.python_package }}"
+readme = "README.md"
+dynamic = ["dependencies", "version"]
+
+[project.scripts]
+{{ cookiecutter.repo_name }} = "{{ cookiecutter.python_package }}.__main__:main"
+
+[project.optional-dependencies]
+docs = [
+    "docutils<0.18.0",
+    "sphinx~=3.4.3",
+    "sphinx_rtd_theme==0.5.1",
+    "nbsphinx==0.8.1",
+    "nbstripout~=0.4",
+    "sphinx-autodoc-typehints==1.11.1",
+    "sphinx_copybutton==0.3.1",
+    "ipykernel>=5.3, <7.0",
+    "Jinja2<3.1.0",
+    "myst-parser~=0.17.2",
+]
+
+[tool.setuptools.dynamic]
+dependencies = {file = "src/requirements.txt"}
+version = {attr = "{{ cookiecutter.python_package }}.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false
+
 [tool.kedro]
-project_name = "{{ cookiecutter.project_name }}"
-project_version = "{{ cookiecutter.kedro_version }}"
 package_name = "{{ cookiecutter.python_package }}"
+project_name = "{{ cookiecutter.project_name }}"
+kedro_init_version = "{{ cookiecutter.kedro_version }}"
 
 [tool.isort]
 profile = "black"

diff --git a/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/pyproject.toml b/features/steps/test_starter/{{ cookiecutter.repo_name }}/src/pyproject.toml
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
diff --git a/kedro/templates/project/{{ cookiecutter.repo_name }}/pyproject.toml b/kedro/templates/project/{{ cookiecutter.repo_name }}/pyproject.toml
@@ -1,3 +1,39 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{{ cookiecutter.python_package }}"
+readme = "README.md"
+dynamic = ["dependencies", "version"]
+
+[project.scripts]
+{{ cookiecutter.repo_name }} = "{{ cookiecutter.python_package }}.__main__:main"
+
+[project.entry-points."kedro.hooks"]
+
+[project.optional-dependencies]
+docs = [
+    "docutils<0.18.0",
+    "sphinx~=3.4.3",
+    "sphinx_rtd_theme==0.5.1",
+    "nbsphinx==0.8.1",
+    "nbstripout~=0.4",
+    "sphinx-autodoc-typehints==1.11.1",
+    "sphinx_copybutton==0.3.1",
+    "ipykernel>=5.3, <7.0",
+    "Jinja2<3.1.0",
+    "myst-parser~=0.17.2",
+]
+
+[tool.setuptools.dynamic]
+dependencies = {file = "src/requirements.txt"}
+version = {attr = "{{ cookiecutter.python_package }}.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false
+
 [tool.kedro]
 package_name = "{{ cookiecutter.python_package }}"
 project_name = "{{ cookiecutter.project_name }}"

diff --git a/kedro/templates/project/{{ cookiecutter.repo_name }}/src/pyproject.toml b/kedro/templates/project/{{ cookiecutter.repo_name }}/src/pyproject.toml
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
diff --git a/tests/framework/cli/test_starters.py b/tests/framework/cli/test_starters.py
@@ -17,7 +17,7 @@
     KedroStarterSpec,
 )
 
-FILES_IN_TEMPLATE = 29
+FILES_IN_TEMPLATE = 28
 
 
 @pytest.fixture