chapkit 0.26.0__tar.gz → 0.28.0__tar.gz

{chapkit-0.26.0 → chapkit-0.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: chapkit
-Version: 0.26.0
+Version: 0.28.0
 Summary: ML and data service modules built on servicekit - config, artifacts, and ML workflows
 Keywords: ml,machine-learning,data-science,artifacts,tasks,config,servicekit
 Author: Morten Hansen
@@ -16,7 +16,7 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Requires-Dist: geojson-pydantic>=2.1.1
 Requires-Dist: typer>=0.24.2
 Requires-Dist: jinja2>=3.1.6
-Requires-Dist: servicekit>=0.11.0
+Requires-Dist: servicekit>=0.12.0
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: pandas>=2.3.3 ; extra == 'dataframe'
 Requires-Dist: polars>=1.34.0 ; extra == 'dataframe'
@@ -257,13 +257,12 @@ Chapkit extends servicekit's `BaseServiceBuilder` with ML-specific features and
 
 See the `examples/` directory for complete working examples:
 
-- `config/` - Config CRUD walkthrough
-- `config_artifact/` - Config with artifact linking
-- `artifact/` - Read-only artifact API with hierarchical storage
-- `ml_functional/`, `ml_class/`, `ml_shell/` - ML workflow patterns (`FunctionalModelRunner`, class-based `BaseModelRunner`, `ShellModelRunner`)
-- `ml_pipeline/` - Multi-stage ML pipeline with hierarchical artifacts
+- `config/` - Config CRUD walkthrough with seeding and a custom `ServiceInfo`
+- `artifact/` - Artifact hierarchies with config linking, read-only API, and non-JSON payloads
+- `ml_class/` - Class-based `BaseModelRunner` with lifecycle hooks and validation
 - `library_usage/` - Using chapkit as a library with custom models
-- `dataframe_usage/` - Working with `chapkit.data.DataFrame`
+
+For the functional and shell runner patterns, scaffold a project with `chapkit init` (`--template shell-py` for the shell runner) — the generated `main.py` is the canonical example.
 
 For a fresh project, prefer `chapkit init` (see [`docs/guides/cli-scaffolding.md`](docs/guides/cli-scaffolding.md)) — the `examples/` directory targets specific patterns rather than a full starting point.
 

{chapkit-0.26.0 → chapkit-0.28.0}/README.md

@@ -219,13 +219,12 @@ Chapkit extends servicekit's `BaseServiceBuilder` with ML-specific features and
 
 See the `examples/` directory for complete working examples:
 
-- `config/` - Config CRUD walkthrough
-- `config_artifact/` - Config with artifact linking
-- `artifact/` - Read-only artifact API with hierarchical storage
-- `ml_functional/`, `ml_class/`, `ml_shell/` - ML workflow patterns (`FunctionalModelRunner`, class-based `BaseModelRunner`, `ShellModelRunner`)
-- `ml_pipeline/` - Multi-stage ML pipeline with hierarchical artifacts
+- `config/` - Config CRUD walkthrough with seeding and a custom `ServiceInfo`
+- `artifact/` - Artifact hierarchies with config linking, read-only API, and non-JSON payloads
+- `ml_class/` - Class-based `BaseModelRunner` with lifecycle hooks and validation
 - `library_usage/` - Using chapkit as a library with custom models
-- `dataframe_usage/` - Working with `chapkit.data.DataFrame`
+
+For the functional and shell runner patterns, scaffold a project with `chapkit init` (`--template shell-py` for the shell runner) — the generated `main.py` is the canonical example.
 
 For a fresh project, prefer `chapkit init` (see [`docs/guides/cli-scaffolding.md`](docs/guides/cli-scaffolding.md)) — the `examples/` directory targets specific patterns rather than a full starting point.
 

{chapkit-0.26.0 → chapkit-0.28.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "chapkit"
-version = "0.26.0"
+version = "0.28.0"
 description = "ML and data service modules built on servicekit - config, artifacts, and ML workflows"
 readme = "README.md"
 authors = [{ name = "Morten Hansen", email = "morten@dhis2.org" }]
@@ -28,7 +28,7 @@ dependencies = [
   "geojson-pydantic>=2.1.1",
   "typer>=0.24.2",
   "jinja2>=3.1.6",
-  "servicekit>=0.11.0",
+  "servicekit>=0.12.0",
   "httpx>=0.28.1",
 ]
 
@@ -145,27 +145,17 @@ disallow_any_unimported = false
 module = [
   "chapkit.artifact.*",
   "chapkit.config.*",
-  "chapkit.task.*",
   "examples.*",
 ]
 warn_return_any = false
 
 [[tool.mypy.overrides]]
-module = "examples.custom_migrations.*"
-ignore_missing_imports = true
-ignore_errors = true
-
-[[tool.mypy.overrides]]
-module = "examples.artifact_manager.*"
-ignore_errors = true
-
-[[tool.mypy.overrides]]
-module = ["chapkit.data.dataframe", "examples.dataframe_usage.*"]
+module = "chapkit.data.dataframe"
 disable_error_code = ["import-not-found"]
 
 [tool.pyright]
 include = ["src", "tests", "examples"]
-exclude = ["examples/artifact_manager", "examples/dataframe_usage", "**/.venv"]
+exclude = ["**/.venv"]
 pythonVersion = "3.13"
 typeCheckingMode = "strict"
 useLibraryCodeForTypes = true

{chapkit-0.26.0 → chapkit-0.28.0}/src/chapkit/artifact/__init__.py

@@ -9,6 +9,8 @@ from .schemas import (
     ArtifactHierarchy,
     ArtifactIn,
     ArtifactOut,
+    ArtifactSummaryOut,
+    ArtifactSummaryTreeNode,
     ArtifactTreeNode,
     BaseArtifactData,
     GenericArtifactData,
@@ -16,6 +18,7 @@ from .schemas import (
     MLMetadata,
     MLPredictionArtifactData,
     MLTrainingWorkspaceArtifactData,
+    strip_content,
     validate_artifact_data,
 )
 
@@ -24,6 +27,8 @@ __all__ = [
     "ArtifactHierarchy",
     "ArtifactIn",
     "ArtifactOut",
+    "ArtifactSummaryOut",
+    "ArtifactSummaryTreeNode",
     "ArtifactTreeNode",
     "ArtifactRepository",
     "ArtifactManager",
@@ -35,5 +40,6 @@ __all__ = [
     "GenericArtifactData",
     "MLMetadata",
     "GenericMetadata",
+    "strip_content",
     "validate_artifact_data",
 ]

{chapkit-0.26.0 → chapkit-0.28.0}/src/chapkit/artifact/router.py

@@ -5,11 +5,17 @@ from typing import Any
 
 from fastapi import Depends, HTTPException, Response, status
 from servicekit.api.crud import CrudPermissions, CrudRouter
+from servicekit.schemas import PaginatedResponse
 
 from ..config.schemas import BaseConfig, ConfigOut
 from ..data import DataFrame
 from .manager import ArtifactManager
-from .schemas import ArtifactIn, ArtifactOut, ArtifactTreeNode
+from .schemas import (
+    ArtifactIn,
+    ArtifactOut,
+    ArtifactSummaryOut,
+    ArtifactSummaryTreeNode,
+)
 
 
 class ArtifactRouter(CrudRouter[ArtifactIn, ArtifactOut]):
@@ -40,6 +46,29 @@ class ArtifactRouter(CrudRouter[ArtifactIn, ArtifactOut]):
             **kwargs,
         )
 
+    def _register_find_all_route(self, manager_dependency: Any, manager_annotation: Any) -> None:
+        """Register the list route returning content-less artifact summaries."""
+        summary_annotation: Any = ArtifactSummaryOut
+        collection_response_model: Any = list[summary_annotation] | PaginatedResponse[summary_annotation]
+
+        @self.router.get("", response_model=collection_response_model)
+        async def find_all(
+            page: int | None = None,
+            size: int | None = None,
+            manager: ArtifactManager = manager_dependency,
+        ) -> list[ArtifactSummaryOut] | PaginatedResponse[ArtifactSummaryOut]:
+            from servicekit.api.pagination import create_paginated_response
+
+            if page is not None and size is not None:
+                items, total = await manager.find_paginated(page, size)
+                summaries = [ArtifactSummaryOut.from_artifact(item) for item in items]
+                return create_paginated_response(summaries, total, page, size)
+            artifacts = await manager.find_all()
+            return [ArtifactSummaryOut.from_artifact(item) for item in artifacts]
+
+        self._annotate_manager(find_all, manager_annotation)
+        find_all.__annotations__["return"] = list[summary_annotation] | PaginatedResponse[summary_annotation]
+
     def _register_routes(self) -> None:
         """Register artifact CRUD routes and tree operations."""
         super()._register_routes()
@@ -49,7 +78,7 @@ class ArtifactRouter(CrudRouter[ArtifactIn, ArtifactOut]):
         async def expand_artifact(
             entity_id: str,
             manager: ArtifactManager = Depends(manager_factory),
-        ) -> ArtifactTreeNode:
+        ) -> ArtifactSummaryTreeNode:
             ulid_id = self._parse_ulid(entity_id)
 
             expanded = await manager.expand_artifact(ulid_id)
@@ -58,12 +87,12 @@ class ArtifactRouter(CrudRouter[ArtifactIn, ArtifactOut]):
                     status_code=status.HTTP_404_NOT_FOUND,
                     detail=f"Artifact with id {entity_id} not found",
                 )
-            return expanded
+            return ArtifactSummaryTreeNode.from_tree_node(expanded)
 
         async def build_tree(
             entity_id: str,
             manager: ArtifactManager = Depends(manager_factory),
-        ) -> ArtifactTreeNode:
+        ) -> ArtifactSummaryTreeNode:
             ulid_id = self._parse_ulid(entity_id)
 
             tree = await manager.build_tree(ulid_id)
@@ -72,22 +101,22 @@ class ArtifactRouter(CrudRouter[ArtifactIn, ArtifactOut]):
                     status_code=status.HTTP_404_NOT_FOUND,
                     detail=f"Artifact with id {entity_id} not found",
                 )
-            return tree
+            return ArtifactSummaryTreeNode.from_tree_node(tree)
 
         self.register_entity_operation(
             "expand",
             expand_artifact,
-            response_model=ArtifactTreeNode,
+            response_model=ArtifactSummaryTreeNode,
             summary="Expand artifact",
-            description="Get artifact with hierarchy metadata but without children",
+            description="Get artifact with hierarchy metadata but without children or content",
         )
 
         self.register_entity_operation(
             "tree",
             build_tree,
-            response_model=ArtifactTreeNode,
+            response_model=ArtifactSummaryTreeNode,
             summary="Build artifact tree",
-            description="Build hierarchical tree structure rooted at the given artifact",
+            description="Build hierarchical tree structure rooted at the given artifact, without content",
         )
 
         # Conditionally register config access endpoint

{chapkit-0.26.0 → chapkit-0.28.0}/src/chapkit/artifact/schemas.py

@@ -39,6 +39,40 @@ class ArtifactTreeNode(ArtifactOut):
         return cls.model_validate(artifact.model_dump())
 
 
+def strip_content(data: Any) -> Any:
+    """Return a shallow copy of artifact data without the heavy 'content' key."""
+    if not isinstance(data, dict):
+        return data
+    return {key: value for key, value in data.items() if key != "content"}
+
+
+class ArtifactSummaryOut(ArtifactOut):
+    """Artifact output without the heavy inline 'content', for list responses."""
+
+    @classmethod
+    def from_artifact(cls, artifact: ArtifactOut) -> Self:
+        """Create a content-less summary from a full artifact output schema."""
+        return cls.model_validate({**artifact.model_dump(exclude={"data"}), "data": strip_content(artifact.data)})
+
+
+class ArtifactSummaryTreeNode(ArtifactTreeNode):
+    """Artifact tree node without inline 'content', with content stripped recursively."""
+
+    @classmethod
+    def from_tree_node(cls, node: ArtifactTreeNode) -> Self:
+        """Create a content-less tree node, stripping content from the node and its children."""
+        children = (
+            [cls.from_tree_node(child).model_dump() for child in node.children] if node.children is not None else None
+        )
+        return cls.model_validate(
+            {
+                **node.model_dump(exclude={"data", "children"}),
+                "data": strip_content(node.data),
+                "children": children,
+            }
+        )
+
+
 class ArtifactHierarchy(BaseModel):
     """Configuration for artifact hierarchy with level labels."""