Change pyproject.toml on Kedro project template to be compatible with…

… `uv`, `rye`, `pdm` (#4263) * Changes to pyproject.toml template Signed-off-by: Laura Couto <[email protected]> * add requires-python to pyproject.toml Signed-off-by: Laura Couto <[email protected]> * Lint Signed-off-by: Laura Couto <[email protected]> * Failing test Signed-off-by: Laura Couto <[email protected]> * Change requirements.txt to -e . Signed-off-by: Laura Couto <[email protected]> * Revert Signed-off-by: Laura Couto <[email protected]> * Changes to pyproject.toml template Signed-off-by: Laura Couto <[email protected]> * add requires-python to pyproject.toml Signed-off-by: Laura Couto <[email protected]> * Lint Signed-off-by: Laura Couto <[email protected]> * Failing test Signed-off-by: Laura Couto <[email protected]> * Change requirements.txt to -e . Signed-off-by: Laura Couto <[email protected]> * Revert Signed-off-by: Laura Couto <[email protected]> * Formatting on cookiecutter placeholders on default template Signed-off-by: Laura Couto <[email protected]> * Add change to release notes Signed-off-by: Laura Couto <[email protected]> * Elaborate on release notes Signed-off-by: Laura Couto <[email protected]> * Update pyproject.toml on test_project Signed-off-by: Laura Couto <[email protected]> * Syntax issues Signed-off-by: Laura Couto <[email protected]> * Changes to pyproject.toml template Signed-off-by: Laura Couto <[email protected]> * add requires-python to pyproject.toml Signed-off-by: Laura Couto <[email protected]> * Lint Signed-off-by: Laura Couto <[email protected]> * Failing test Signed-off-by: Laura Couto <[email protected]> * Change requirements.txt to -e . Signed-off-by: Laura Couto <[email protected]> * Revert Signed-off-by: Laura Couto <[email protected]> * add requires-python to pyproject.toml Signed-off-by: Laura Couto <[email protected]> * Lint Signed-off-by: Laura Couto <[email protected]> * Failing test Signed-off-by: Laura Couto <[email protected]> * Change requirements.txt to -e . Signed-off-by: Laura Couto <[email protected]> * Revert Signed-off-by: Laura Couto <[email protected]> * Formatting on cookiecutter placeholders on default template Signed-off-by: Laura Couto <[email protected]> * Add change to release notes Signed-off-by: Laura Couto <[email protected]> * Elaborate on release notes Signed-off-by: Laura Couto <[email protected]> * Update pyproject.toml on test_project Signed-off-by: Laura Couto <[email protected]> * Syntax issues Signed-off-by: Laura Couto <[email protected]> * Fix accidentally removed line Signed-off-by: Laura Couto <[email protected]> * Fix duplicated line Signed-off-by: Laura Couto <[email protected]> --------- Signed-off-by: Laura Couto <[email protected]>
kedro-org · Nov 13, 2024 · 9464dc7 · 9464dc7
1 parent 075d59b
commit 9464dc7
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 10 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -3,6 +3,7 @@
 ## Major features and improvements
 * Implemented dict-like interface for `KedroDataCatalog`.
 * Implemented lazy dataset initializing for `KedroDataCatalog`.
+* Project dependencies on both the default template and on starter templates are now explicitly declared on the `pyproject.toml` file, allowing Kedro projects to work with project management tools like `uv`, `pdm`, and `rye`.
 
 **Note:** ``KedroDataCatalog`` is an experimental feature and is under active development. Therefore, it is possible we'll introduce breaking changes to this class, so be mindful of that if you decide to use it already. Let us know if you have any feedback about the ``KedroDataCatalog`` or ideas for new features.
 

diff --git a/features/steps/test_starter/{{ cookiecutter.repo_name }}/pyproject.toml b/features/steps/test_starter/{{ cookiecutter.repo_name }}/pyproject.toml
@@ -3,12 +3,20 @@ requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 [project]
+requires-python = ">=3.9"
 name = "{{ cookiecutter.python_package }}"
 readme = "README.md"
-dynamic = ["dependencies", "version"]
+dynamic = ["version"]
+dependencies = [
+    "ipython>=8.10",
+    "jupyterlab>=3.0",
+    "notebook",
+    "kedro~={{ cookiecutter.kedro_version }}",
+    "kedro-datasets[pandas-csvdataset]"
+]
 
 [project.scripts]
-{{ cookiecutter.repo_name }} = "{{ cookiecutter.python_package }}.__main__:main"
+"{{ cookiecutter.repo_name }}" = "{{ cookiecutter.python_package }}.__main__:main"
 
 [project.optional-dependencies]
 docs = [
@@ -30,7 +38,6 @@ dev = [
 ]
 
 [tool.setuptools.dynamic]
-dependencies = {file = "requirements.txt"}
 version = {attr = "{{ cookiecutter.python_package }}.__version__"}
 
 [tool.setuptools.packages.find]
@@ -41,7 +48,7 @@ namespaces = false
 package_name = "{{ cookiecutter.python_package }}"
 project_name = "{{ cookiecutter.project_name }}"
 kedro_init_version = "{{ cookiecutter.kedro_version }}"
-tools = {{ cookiecutter.tools | default('') | string | replace('\"', '\\\"') }}
+tools = "{{ cookiecutter.tools | default('') | string | replace('\"', '\\\"') }}"
 example_pipeline = "{{ cookiecutter.example_pipeline }}"
 source_dir = "src"
 

diff --git a/features/steps/test_starter/{{ cookiecutter.repo_name }}/requirements.txt b/features/steps/test_starter/{{ cookiecutter.repo_name }}/requirements.txt
@@ -1,5 +1,5 @@
 ipython>=8.10
 jupyterlab>=3.0
 notebook
-kedro~={{ cookiecutter.kedro_version}}
+kedro~={{ cookiecutter.kedro_version }}
 kedro-datasets[pandas-csvdataset]
diff --git a/kedro/templates/project/{{ cookiecutter.repo_name }}/pyproject.toml b/kedro/templates/project/{{ cookiecutter.repo_name }}/pyproject.toml
@@ -3,12 +3,19 @@ requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 [project]
+requires-python = ">=3.9"
 name = "{{ cookiecutter.python_package }}"
 readme = "README.md"
-dynamic = ["dependencies", "version"]
+dynamic = ["version"]
+dependencies = [
+    "ipython>=8.10",
+    "jupyterlab>=3.0",
+    "notebook",
+    "kedro~={{ cookiecutter.kedro_version }}"
+]
 
 [project.scripts]
-{{ cookiecutter.repo_name }} = "{{ cookiecutter.python_package }}.__main__:main"
+"{{ cookiecutter.repo_name }}" = "{{ cookiecutter.python_package }}.__main__:main"
 
 [project.entry-points."kedro.hooks"]
 
@@ -31,9 +38,7 @@ dev = [
     "ruff~=0.1.8"
 ]
 
-
 [tool.setuptools.dynamic]
-dependencies = {file = "requirements.txt"}
 version = {attr = "{{ cookiecutter.python_package }}.__version__"}
 
 [tool.setuptools.packages.find]
@@ -44,7 +49,7 @@ namespaces = false
 package_name = "{{ cookiecutter.python_package }}"
 project_name = "{{ cookiecutter.project_name }}"
 kedro_init_version = "{{ cookiecutter.kedro_version }}"
-tools = {{ cookiecutter.tools | default('') | string | replace('\"', '\\\"') }}
+tools = "{{ cookiecutter.tools | default('') | string | replace('\"', '\\\"') }}"
 example_pipeline = "{{ cookiecutter.example_pipeline }}"
 source_dir = "src"