Add pyproject.toml as a dependencies file option (#436)

* Add pyproject.toml option for dependencies file

* Update make requirements

* Prefer uv sync over uv pip install

* Deduplicate in verify_files

* Update configuration

* Undo whitespace changes

* Undo whitespace change

* Shouldn't need set on existing_files

---------

Co-authored-by: Jay Qi <[email protected]>

Author: jayqi

ccds-help.json

@@ -166,9 +166,16 @@
             {
                 "choice": "requirements.txt",
                 "help": {
-                    "description": "Most general, least feature-rich format for use with `pip`.",
-                    "more_information": "[pip docs](https://pip.pypa.io/en/stable/reference/requirements-file-format/)"
-                } 
+                    "description": "Classic format for a list of packages to be installed by `pip`.",
+                    "more_information": "[Docs](https://pip.pypa.io/en/stable/reference/requirements-file-format/)"
+                }
+            },
+            {
+                "choice": "pyproject.toml",
+                "help": {
+                    "description": "Modern configuration file for Python projects.",
+                    "more_information": "[Docs](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/)"
+                }
             },
             {
                 "choice": "environment.yml",

ccds.json

@@ -20,6 +20,7 @@
     ],
     "dependency_file": [
         "requirements.txt",
+        "pyproject.toml",
         "environment.yml",
         "Pipfile"
     ],

ccds/hook_utils/dependencies.py

@@ -1,3 +1,5 @@
+import tomlkit
+
 packages = [
     "pip",
     "python-dotenv",
@@ -40,6 +42,15 @@ def write_dependencies(
             f.write("\n".join(lines))
             f.write("\n")
 
+    elif dependencies == "pyproject.toml":
+        with open(dependencies, "r") as f:
+            doc = tomlkit.parse(f.read())
+        doc["project"].add("dependencies", sorted(packages))
+        doc["project"]["dependencies"].multiline(True)
+
+        with open(dependencies, "w") as f:
+            f.write(tomlkit.dumps(doc))
+
     elif dependencies == "environment.yml":
         with open(dependencies, "w") as f:
             lines = [

pyproject.toml

@@ -32,6 +32,7 @@ requires-python = ">=3.9"
 dependencies = [
   "click",
   "cookiecutter",
+  "tomlkit",
 ]
 
 [project.scripts]

tests/test_creation.py

@@ -146,7 +146,7 @@ def verify_files(root, config):
 
     existing_files = [f.relative_to(root) for f in root.glob("**/*") if f.is_file()]
 
-    assert sorted(existing_files) == sorted(expected_files)
+    assert sorted(existing_files) == sorted(set(expected_files))
 
     for f in existing_files:
         assert no_curlies(root / f)

{{ cookiecutter.repo_name }}/Makefile

@@ -21,6 +21,12 @@ requirements:
 	$(PYTHON_INTERPRETER) -m pip install -U pip
 	$(PYTHON_INTERPRETER) -m pip install -r requirements.txt
 	{% endif -%}
+	{% elif "pyproject.toml" == cookiecutter.dependency_file -%}
+	{% if "uv" == cookiecutter.environment_manager -%}
+	uv sync
+	{% else -%}
+	pip install -e .
+	{% endif -%}
 	{% elif "environment.yml" == cookiecutter.dependency_file -%}
 	conda env update --name $(PROJECT_NAME) --file environment.yml --prune
 	{% elif "Pipfile" == cookiecutter.dependency_file -%}