fix(datashare-python,worker-template): template package name

Author: ClemDoum

datashare-python/datashare_python/template.py

@@ -1,4 +1,5 @@
 import os
+import shutil
 import tarfile
 from copy import deepcopy
 from importlib.resources import as_file, files
@@ -48,25 +49,26 @@ def build_template_tarball() -> None:
 def init_project(name: str, path: Path) -> None:
     destination = path / name
     template_tar = files("datashare_python")
+    package_name = name.replace("-", "_").lower()
     with (
         as_file(template_tar / "worker-template.tar.gz") as tar_path,
         tarfile.open(tar_path, mode="r:gz") as tar,
     ):
         tar.extractall(destination)
+    package_dir = destination / package_name
+    shutil.move(destination / "worker_template", package_dir)
     pyproject_toml_path = destination / "pyproject.toml"
     pyproject_toml = tomlkit.loads(pyproject_toml_path.read_text())
-    pyproject_toml = _update_pyproject_toml(pyproject_toml, project_name=name)
+    pyproject_toml = _update_pyproject_toml(pyproject_toml, package_name=package_name)
     pyproject_toml_path.write_text(tomlkit.dumps(pyproject_toml))
 
 
 _BASE_DEPS = {"datashare-python", "icij-common", "temporalio"}
 
 
 def _update_pyproject_toml(
-    pyproject_toml: dict[str, Any], *, project_name: str
+    pyproject_toml: dict[str, Any], *, package_name: str
 ) -> dict[str, Any]:
-    lower_snaked = project_name.replace("-", "_").lower()
-
     pyproject_toml = deepcopy(pyproject_toml)
 
     pyproject_toml["tool"]["uv"].pop("sources")
@@ -90,13 +92,19 @@ def _update_pyproject_toml(
     entry_points = project["entry-points"]
 
     wf_entry_point = entry_points["datashare.workflows"]["workflows"]
-    wf_entry_point = wf_entry_point.replace("worker_template", lower_snaked)
+    wf_entry_point = wf_entry_point.replace("worker_template", package_name)
     entry_points["datashare.workflows"]["workflows"] = wf_entry_point
 
     activities_entry_point = entry_points["datashare.activities"]["activities"]
     activities_entry_point = activities_entry_point.replace(
-        "worker_template", lower_snaked
+        "worker_template", package_name
     )
     entry_points["datashare.activities"]["activities"] = activities_entry_point
 
+    hatch_sdist = pyproject_toml["tool"]["hatch"]["build"]["targets"]["sdist"]
+    hatch_sdist["only-include"] = [
+        i if i != "worker_template" else package_name
+        for i in hatch_sdist["only-include"]
+    ]
+
     return pyproject_toml

datashare-python/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "datashare-python"
-version = "0.2.20"
+version = "0.2.21"
 description = "Manage Pythoœn tasks and local resources in Datashare"
 authors = [
   { name = "Clément Doumouro", email = "cdoumouro@icij.org" },

datashare-python/tests/test_template.py

@@ -10,15 +10,19 @@ async def test_init_project(
 ) -> None:
     # Given
     test_worker_project = "test-project"
+
     # When
     init_project(test_worker_project, tmp_path)
+
     # Then
     project_path = tmp_path / test_worker_project
 
     assert project_path.exists()
     pyproject_toml_path = project_path / "pyproject.toml"
-
     assert pyproject_toml_path.exists()
+    package_path = project_path / "test_project"
+    assert package_path.exists()
+
     pyproject_toml = tomlkit.loads(pyproject_toml_path.read_text())
 
     project = pyproject_toml["project"]
@@ -38,3 +42,6 @@ async def test_init_project(
     assert wf_entrypoints == "test_project.workflows:WORKFLOWS"
     acts = entry_points["datashare.activities"]["activities"]
     assert acts == "test_project.activities:ACTIVITIES"
+
+    hatch_sdist = pyproject_toml["tool"]["hatch"]["build"]["targets"]["sdist"]
+    assert hatch_sdist["only-include"] == ["test_project"]

worker-template/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "datashare-worker-template"
-version = "0.1.3"
+version = "0.1.4"
 description = "Datashare worker template"
 authors = [
   { name = "Clément Doumouro", email = "cdoumouro@icij.org" },
@@ -60,13 +60,8 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 package = ["worker_template"]
 
-# Include non python files into the source so that we can copy them as template when the package is distributed
-[tool.hatch.build.targets.wheel.force-include]
-"pyproject.toml" = "worker_template/template/pyproject.toml"
-"README.md" = "worker_template/template/README.md"
-"tests" = "worker_template/template/tests"
-"uv.lock" = "worker_template/template/uv.lock"
-"worker_template" = "worker_template/template/worker_template"
+[tool.hatch.build.targets.sdist]
+only-include = ["worker_template"]
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"