csrd-utils 0.3.44__tar.gz → 0.3.46__tar.gz

{csrd_utils-0.3.44 → csrd_utils-0.3.46}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: csrd-utils
-Version: 0.3.44
+Version: 0.3.46
 Summary: CLI utilities for csrd service generation and feature augmentation
 Project-URL: Repository, https://github.com/csrd-api/fastapi-common
 Project-URL: Documentation, https://github.com/csrd-api/fastapi-common/tree/main/packages/utils

{csrd_utils-0.3.44 → csrd_utils-0.3.46}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "csrd-utils"
-version = "0.3.44"
+version = "0.3.46"
 description = "CLI utilities for csrd service generation and feature augmentation"
 license = { text = "MIT" }
 requires-python = ">=3.12"

{csrd_utils-0.3.44 → csrd_utils-0.3.46}/src/csrd_utils/__main__.py

@@ -784,9 +784,7 @@ def _extract_service(config: ExtractWorkspaceServiceArgs) -> dict[str, object]:
         _load_workspace_cluster_spec(target_workspace), source_service_spec, target_workspace.name
     )
     _save_workspace_cluster_spec(target_workspace, target_spec)
-    target_cluster_root = generate_cluster(
-        target_spec, target_workspace, force=True, workspace_mode=True
-    )
+    target_cluster_root = generate_cluster(target_spec, target_workspace, force=True)
 
     source_cluster_root = None
     if mode == "move":
@@ -795,9 +793,7 @@ def _extract_service(config: ExtractWorkspaceServiceArgs) -> dict[str, object]:
             _load_workspace_cluster_spec(source_workspace), service_root.name, source_workspace.name
         )
         _save_workspace_cluster_spec(source_workspace, source_spec)
-        source_cluster_root = generate_cluster(
-            source_spec, source_workspace, force=True, workspace_mode=True
-        )
+        source_cluster_root = generate_cluster(source_spec, source_workspace, force=True)
 
     return {
         "ok": True,
@@ -897,7 +893,7 @@ def _maybe_update_workspace_cluster(
             service_config,
             overwrite=service_config["overwrite_if_exists"],
         )
-        return generate_cluster(updated_spec, workspace_root, force=True, workspace_mode=True)
+        return generate_cluster(updated_spec, workspace_root, force=True)
 
     service_roots = _workspace_service_roots(workspace_root)
     generated_name = generated_service.name
@@ -914,7 +910,7 @@ def _maybe_update_workspace_cluster(
     }
     normalized = normalize_cluster_spec(bootstrap_spec)
     _save_workspace_cluster_spec(workspace_root, normalized)
-    return generate_cluster(normalized, workspace_root, force=True, workspace_mode=True)
+    return generate_cluster(normalized, workspace_root, force=True)
 
 
 def _build_parser() -> argparse.ArgumentParser:

{csrd_utils-0.3.44 → csrd_utils-0.3.46}/src/csrd_utils/cluster.py

@@ -426,6 +426,21 @@ def _build_readme(spec: ClusterSpec) -> str:
         lines.append(f"- `{service['name']}` ({service['type']}) on port `{service['port']}`")
     lines.extend(
         [
+            "",
+            "## Tests",
+            "",
+            "From the workspace root, run all tests:",
+            "",
+            "```bash",
+            "pytest",
+            "```",
+            "",
+            "Run tests for a specific service:",
+            "",
+            "```bash",
+            "pytest tests/unit/{service_name}",
+            "pytest tests/acceptance/{service_name}",
+            "```",
             "",
             "## Run",
             "",
@@ -456,23 +471,20 @@ def _build_smoke(spec: ClusterSpec) -> str:
     return "\n".join(lines) + "\n"
 
 
-def generate_cluster(
-    spec: ClusterSpec, output_dir: Path, force: bool = False, workspace_mode: bool = False
-) -> Path:
-    normalized = normalize_cluster_spec(spec)
-
-    if workspace_mode:
-        # In workspace mode, write files directly to output_dir (workspace root)
-        cluster_root = output_dir.resolve()
-    else:
-        # In standalone mode, create a subdirectory with cluster name
-        cluster_root = output_dir.resolve() / normalized["cluster"]["name"]
+def generate_cluster(spec: ClusterSpec, output_dir: Path, force: bool = False) -> Path:
+    """Generate cluster scaffold in workspace mode.
 
+    Always operates at workspace root (no standalone mode).
+    """
+    normalized = normalize_cluster_spec(spec)
+    cluster_root = output_dir.resolve()
     cluster_root.mkdir(parents=True, exist_ok=True)
 
-    if any(cluster_root.iterdir()) and not force:
+    # In workspace mode, check if we'd overwrite existing cluster artifacts
+    compose_file = cluster_root / "docker-compose.yml"
+    if compose_file.exists() and not force:
         raise FileExistsError(
-            f"Target directory already exists and is not empty: {cluster_root}. Use --force to overwrite."
+            f"Cluster files already exist in {cluster_root}. Use --force to overwrite."
         )
 
     compose = render_compose(normalized)
@@ -480,7 +492,12 @@ def generate_cluster(
         yaml.safe_dump(compose, sort_keys=False), encoding="utf-8"
     )
     (cluster_root / ".env.example").write_text(_build_env(normalized), encoding="utf-8")
-    (cluster_root / "README.md").write_text(_build_readme(normalized), encoding="utf-8")
+
+    # In workspace mode, preserve existing README (workspace-level, not cluster-specific)
+    readme_path = cluster_root / "README.md"
+    if not readme_path.exists():
+        readme_path.write_text(_build_readme(normalized), encoding="utf-8")
+
     smoke_path = cluster_root / "smoke.sh"
     smoke_path.write_text(_build_smoke(normalized), encoding="utf-8")
     smoke_path.chmod(0o755)

{csrd_utils-0.3.44 → csrd_utils-0.3.46}/src/csrd_utils/generator.py

@@ -9,6 +9,111 @@ from cookiecutter.main import cookiecutter
 
 from .resources import templates_path
 
+_WORKSPACE_PYPROJECT_BASE = """\
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "workspace"
+version = "0.1.0"
+description = "Multi-service workspace"
+readme = "README.md"
+requires-python = ">=3.12"
+license = {text = "MIT"}
+
+dependencies = [
+    "fastapi>=0.110",
+    "uvicorn[standard]>=0.27",
+    "pydantic[email]>=2.5",
+    "csrd-versioning @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/versioning",
+    "csrd-lifespan @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/lifespan",
+    "csrd-repository @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/repository",
+    "csrd-context @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/context",
+    "httpx>=0.25",
+    "celery[redis]>=5.3",
+    "celery[amqp]>=5.3",
+    "redis>=5.0",
+    "csrd-logging @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/logging",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4",
+    "pytest-asyncio>=0.21",
+    "mypy>=1.7",
+    "ruff>=0.1",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[tool.mypy]
+python_version = "3.12"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+strict = true
+
+[tool.ruff]
+target-version = "py312"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP", "BLE", "FBT", "A", "C4", "PIE", "SIM", "RUF"]
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = [""]
+"""
+
+_WORKSPACE_README = """\
+# Workspace
+
+Generated workspace with one or more microservices.
+
+## Run tests
+
+From the workspace root, run all tests:
+
+```bash
+pytest
+```
+
+Run tests for a specific service:
+
+```bash
+pytest tests/unit/{service_name}
+pytest tests/acceptance/{service_name}
+```
+
+Run tests in watch mode (requires `pytest-watch`):
+
+```bash
+ptw
+```
+
+## Run services
+
+See individual service README files under `src/{service_name}/README.md` for instructions on running each service.
+
+## Docker Compose
+
+Run all services and infrastructure:
+
+```bash
+docker compose up --build
+```
+
+Check service health:
+
+```bash
+./smoke.sh
+```
+"""
+
 
 def _build_context(
     *,
@@ -123,6 +228,12 @@ def generate_service(
     _move_docker_files_to_workspace_root(generated_path, output_root, name)
     _move_tests_to_workspace_root(generated_path, output_root, name)
 
+    # Ensure workspace root has a pyproject.toml with pytest config.
+    _write_workspace_pyproject(output_root)
+
+    # Ensure workspace root has a README with test running instructions.
+    _write_workspace_readme(output_root)
+
     return generated_path
 
 
@@ -193,3 +304,32 @@ def _move_tests_to_workspace_root(
             shutil.copy2(src_file, acceptance_dst / filename)
 
     shutil.rmtree(tests_src, ignore_errors=True)
+
+
+def _write_workspace_pyproject(workspace_root: Path) -> None:
+    """Write workspace-level pyproject.toml with full build/project/tool configuration.
+
+    Creates complete pyproject.toml on first generation. On subsequent generations,
+    only writes if the file doesn't exist or lacks [project] section (user customization).
+    """
+    dst = workspace_root / "pyproject.toml"
+    if dst.exists():
+        existing = dst.read_text(encoding="utf-8")
+        # If user already has a [project] section, assume they customized it
+        if "[project]" in existing:
+            return
+        # Otherwise write the full base config
+        dst.write_text(_WORKSPACE_PYPROJECT_BASE, encoding="utf-8")
+    else:
+        dst.write_text(_WORKSPACE_PYPROJECT_BASE, encoding="utf-8")
+
+
+def _write_workspace_readme(workspace_root: Path) -> None:
+    """Write workspace-level README.md with test running and setup instructions.
+
+    If the file does not exist it is created from scratch.  If it already exists
+    it is left untouched (the user may have customised it).
+    """
+    dst = workspace_root / "README.md"
+    if not dst.exists():
+        dst.write_text(_WORKSPACE_README, encoding="utf-8")

{csrd_utils-0.3.44 → csrd_utils-0.3.46}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/tests/conftest.py

@@ -1,15 +1,11 @@
 """Shared test fixtures for {{ cookiecutter.service_name }}."""
 
 import os
-import sys
-from pathlib import Path
 
 import pytest
 from fastapi.testclient import TestClient
 
-sys.path.insert(0, str(Path(__file__).parent.parent / "src"))
-
-from app import build_app
+from {{cookiecutter.__service_name_snake}} import build_app
 
 HAS_DATABASE = {{"True" if cookiecutter.has_database else "False"}}
 DB_KIND = "{{ cookiecutter.database }}"

{csrd_utils-0.3.44 → csrd_utils-0.3.46}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/tests/test_items.py

@@ -111,7 +111,7 @@ def test_delegate_create_and_list(monkeypatch, client):
             return {"id": "d1", "name": payload["name"], "created_at": "2026-01-01T00:00:00Z"}
         return {"{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}": [{"id": "d1", "name": "X", "created_at": "t"}]}
 
-    monkeypatch.setattr("app.views.unversioned.items_view._delegate_request", fake_delegate_request)
+    monkeypatch.setattr("{{cookiecutter.__service_name_snake}}.views.unversioned.items_view._delegate_request", fake_delegate_request)
 
     created = client.post(
         "/api/{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}", json={"name": "X"}
@@ -130,7 +130,7 @@ def test_delegate_error_mapping(monkeypatch, client):
     async def fake_delegate_request(_method: str, _path: str, payload=None):
         raise HTTPException(status_code=404, detail="not found")
 
-    monkeypatch.setattr("app.views.unversioned.items_view._delegate_request", fake_delegate_request)
+    monkeypatch.setattr("{{cookiecutter.__service_name_snake}}.views.unversioned.items_view._delegate_request", fake_delegate_request)
     response = client.get("/api/{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}/missing")
     assert response.status_code == 404
 
@@ -147,7 +147,7 @@ def test_delegate_get_update_upsert_delete(monkeypatch, client):
             return {"id": "d2", "deleted": True}
         return {}
 
-    monkeypatch.setattr("app.views.unversioned.items_view._delegate_request", fake_delegate_request)
+    monkeypatch.setattr("{{cookiecutter.__service_name_snake}}.views.unversioned.items_view._delegate_request", fake_delegate_request)
 
     fetched = client.get("/api/{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}/d2")
     assert fetched.status_code == 200
@@ -176,7 +176,7 @@ def test_delegate_list_invalid_payload_returns_502(monkeypatch, client):
     async def fake_delegate_request(_method: str, _path: str, payload=None):
         return {"{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}": "bad"}
 
-    monkeypatch.setattr("app.views.unversioned.items_view._delegate_request", fake_delegate_request)
+    monkeypatch.setattr("{{cookiecutter.__service_name_snake}}.views.unversioned.items_view._delegate_request", fake_delegate_request)
     response = client.get("/api/{{ cookiecutter.model_name_plural | lower | replace(' ', '_') }}")
     assert response.status_code == 502
 {%- endif %}

{csrd_utils-0.3.44 → csrd_utils-0.3.46}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/tests/unit/test_cache.py

@@ -17,7 +17,7 @@ def test_cache_client_uses_decode_responses() -> None:
 
 
 def test_cache_client_uses_runtime_cache_url() -> None:
-    settings_mod = importlib.import_module("app.settings")
+    settings_mod = importlib.import_module("{{cookiecutter.__service_name_snake}}.settings")
     original = settings_mod.settings.cache_url
     try:
         settings_mod.settings.cache_url = "redis://cache-host:6381/2"

{csrd_utils-0.3.44 → csrd_utils-0.3.46}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/tests/unit/test_settings_contracts.py

@@ -73,11 +73,11 @@ def test_validate_db_credentials_rejects_weak_defaults(
 
 def test_app_package_init_modules_expose_tuple_all() -> None:
     for module_name in [
-        "app.delegates",
-        "app.dependencies",
-        "app.middleware",
-        "app.repositories",
-        "app.workers",
+        "{{cookiecutter.__service_name_snake}}.delegates",
+        "{{cookiecutter.__service_name_snake}}.dependencies",
+        "{{cookiecutter.__service_name_snake}}.middleware",
+        "{{cookiecutter.__service_name_snake}}.repositories",
+        "{{cookiecutter.__service_name_snake}}.workers",
     ]:
         module = importlib.import_module(module_name)
         exports = getattr(module, "__all__", ())

{csrd_utils-0.3.44 → csrd_utils-0.3.46}/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/tests/unit/test_worker_broker.py

@@ -16,7 +16,7 @@ def test_ping_task_returns_pong() -> None:
 
 
 def test_worker_broker_url_reflects_runtime_settings() -> None:
-    settings_mod = importlib.import_module("app.settings")
+    settings_mod = importlib.import_module("{{cookiecutter.__service_name_snake}}.settings")
     original = settings_mod.settings.worker_broker_url
     try:
         settings_mod.settings.worker_broker_url = "amqp://runtime-test"

csrd_utils-0.3.44/src/csrd_utils/templates/cookiecutter-service/{{cookiecutter.__service_name_snake}}/pyproject.toml

@@ -1,61 +0,0 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[project]
-name = "{{ cookiecutter.service_name }}"
-version = "0.1.0"
-description = "{{ cookiecutter.service_description }}"
-readme = "README.md"
-requires-python = ">=3.12"
-license = {text = "MIT"}
-authors = [{name = "Generated by csrd", email = "generated@csrd.local"}]
-keywords = ["fastapi", "microservice", "csrd"]
-
-dependencies = [
-    "fastapi>=0.110",
-    "uvicorn[standard]>=0.27",
-    "pydantic[email]>=2.5",
-    "csrd-versioning @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/versioning",
-    "csrd-lifespan @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/lifespan",
-    "csrd-repository @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/repository",
-    "csrd-context @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/context",
-    "httpx>=0.25",
-    "celery[redis]>=5.3",
-    "celery[amqp]>=5.3",
-    "redis>=5.0",
-    "csrd-logging @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/logging",
-]
-
-[project.optional-dependencies]
-dev = [
-    "pytest>=7.4",
-    "pytest-asyncio>=0.21",
-    "mypy>=1.7",
-    "ruff>=0.1",
-]
-
-[tool.hatch.build.targets.wheel]
-packages = ["{{cookiecutter.__service_name_snake}}"]
-
-[tool.pytest.ini_options]
-asyncio_mode = "auto"
-testpaths = ["tests"]
-
-[tool.mypy]
-python_version = "3.12"
-warn_return_any = true
-warn_unused_configs = true
-disallow_untyped_defs = true
-strict = true
-
-[tool.ruff]
-target-version = "py312"
-line-length = 100
-
-[tool.ruff.lint]
-select = ["E", "F", "W", "I", "N", "UP", "BLE", "FBT", "A", "C4", "PIE", "SIM", "RUF"]
-ignore = ["E501"]
-
-[tool.ruff.lint.isort]
-known-first-party = ["{{cookiecutter.__service_name_snake}}"]