ts-lib-artifacts 0.1.0__py3-none-any.whl

ts_lib_artifacts/README.md

@@ -0,0 +1,8 @@
+# `external` Package
+
+This package contains all domain logic that lives outside the CLI's command-handling layer. It is split into two sub-packages:
+
+- **`core`** — Framework-level abstractions (API client, base artifact type, file I/O, template engine) that are artifact-type-agnostic.
+- **`artifacts`** — Concrete artifact type implementations (protocol, task-script, IDS, etc.) that plug into the core framework.
+
+The separation keeps the CLI commands thin: they parse arguments and delegate to `external` for all platform interaction, validation, patching, and templating.

ts_lib_artifacts/artifacts/README.md

@@ -0,0 +1,37 @@
+# `external.artifacts` Package
+
+Concrete artifact type implementations for the Tetra Data Platform. Each sub-package implements a single artifact kind by extending the base classes from `external.core`.
+
+## Artifact Types
+
+| Type | Class | Base Class | Description |
+|------|-------|------------|-------------|
+| `protocol` | `Protocol` | `PipelineArtifact` | Protocols (master scripts) with v3 validation |
+| `task-script` | `TaskScript` | `PipelineArtifact` | Task scripts used by protocols |
+| `ids` | `IDS` | `PipelineArtifact` | Intermediate Data Schemas |
+| `schema` | `Schema` | `ArtifactTemplateGroup` | Schemas with expected output files |
+| `data-app` | `DataApp` | `ArtifactTemplateGroup` | Containerized data applications |
+| `connector` | `Connector` | `ArtifactType` | Containerized connectors |
+| `tetraflow` | `Tetraflow` | `ArtifactTemplateGroup` | Tetraflow artifacts |
+
+## Inheritance Hierarchy
+
+```
+ArtifactType (core)          TemplateGroup (core)
+     │                            │
+     └──── ArtifactTemplateGroup ─┘   (artifact_template.py)
+                  │
+           PipelineArtifact           (pipeline_artifact.py)
+           │    │    │
+      Protocol  TaskScript  IDS
+```
+
+- **`ArtifactTemplateGroup`** — combines `ArtifactType` + `TemplateGroup`, providing default template and environment schema behavior. Used directly by Schema, DataApp, and Tetraflow.
+- **`PipelineArtifact`** — extends `ArtifactTemplateGroup` with pipeline-based dependency tracking (`get_dependents` queries pipelines that use the artifact). Used by Protocol, TaskScript, and IDS.
+
+## Structure
+
+Each artifact sub-package typically contains:
+- `__init__.py` — the artifact class implementation
+- `templates/` — Jinja2 template directories organized by `<template_name>/<platform_version>/`
+- Type-specific modules (e.g. `patches.py`, validation logic)

ts_lib_artifacts/artifacts/__init__.py

@@ -0,0 +1,7 @@
+from .connector import Connector
+from .data_app import DataApp
+from .ids import IDS
+from .protocol import Protocol
+from .schema import Schema
+from .task_script import TaskScript
+from .tetraflow import Tetraflow

ts_lib_artifacts/artifacts/artifact_template.py

@@ -0,0 +1,15 @@
+from abc import ABC
+
+from ..core.artifact_type import ArtifactType
+from ..core.templates import TemplateGroup
+
+
+class ArtifactTemplateGroup(ArtifactType, TemplateGroup, ABC):
+
+    @property
+    def group_name(self) -> str:
+        return self.artifact_type
+
+    @property
+    def default_template(self) -> str:
+        return "default"

ts_lib_artifacts/artifacts/connector/README.md

@@ -0,0 +1,23 @@
+# Connector
+
+Artifact type for containerized connectors that integrate external systems with the platform.
+
+## Class: `Connector`
+
+Extends `ArtifactType` directly (no template support).
+
+- **Type identifier**: `"connector"`
+- **Max size**: unlimited
+
+## Validation
+
+- Requires `image.tar` in the source directory (Docker image)
+
+## Patches
+
+- `PyprojectToml` — standard pyproject.toml patching
+- `PackageJson` — standard package.json patching
+
+## Notes
+
+Connector has no templates, no dependency tracking, and no environment schema. It is the simplest containerized artifact type. Data apps are a subtype of connector on the platform side.

ts_lib_artifacts/artifacts/connector/__init__.py

@@ -0,0 +1,32 @@
+import os
+from os import PathLike
+
+from ...core.api import ApiConfigLike
+from ...core.artifact_type import ArtifactType, ValidationResult
+from ...core.artifact_type.patch import PackageJson, Patch, PyprojectToml
+
+
+class Connector(ArtifactType):
+    @property
+    def artifact_type(self) -> str:
+        return "connector"
+
+    def validate_source(
+        self, path: PathLike, api_config: ApiConfigLike
+    ) -> ValidationResult:
+        package_content = os.listdir(path)
+        if "image.tar" not in package_content:
+            return ValidationResult(
+                errors=[
+                    "Connector package must contain 'image.tar' containing the Connector's Docker image."
+                ]
+            )
+        return ValidationResult()
+
+    @property
+    def max_size(self) -> float:
+        return float("inf")
+
+    @property
+    def patches(self) -> list[Patch]:
+        return [PyprojectToml(), PackageJson()]

ts_lib_artifacts/artifacts/data_app/README.md

@@ -0,0 +1,43 @@
+# Data App
+
+Artifact type for containerized data applications deployed on the platform.
+
+## Class: `DataApp`
+
+Extends `ArtifactTemplateGroup`.
+
+- **Type identifier**: `"data-app"`
+- **Legacy type**: `"connectors"`
+- **Client type**: `"data-app"`
+- **Max size**: unlimited
+
+## Validation
+
+- Requires `image.tar` in the source directory (Docker image built via `poetry run poe build-for-publish`)
+- Manifest must include a label `{"name": "subtype", "value": "data-app"}`
+
+## Patches
+
+- `PyprojectToml` — standard pyproject.toml patching
+- `PackageJson` — standard package.json patching
+
+## Manifest
+
+Overrides `update_manifest` to set `type` to `"connector"` (data apps are a subtype of connector on the platform).
+
+## Dependencies
+
+Queries the data apps API endpoint and matches by scope/slug/version.
+
+## Templates
+
+| Template  | Platform Versions |
+|-----------|-------------------|
+| streamlit | 4.3               |
+| react     | 4.3               |
+
+Default template: `streamlit`.
+
+## Environment Decoration
+
+`decorate_environment` derives additional template variables from the collected environment: `artifact_title`, `package_dir`, `package_name`, `semver_version`, and `pep_440_version`.

ts_lib_artifacts/artifacts/data_app/__init__.py

@@ -0,0 +1,137 @@
+import os
+from os import PathLike
+from pathlib import Path
+
+from ...core.api import ApiConfigLike, TsApi
+from ...core.artifact_key import ArtifactKey
+from ...core.artifact_type import ValidationResult
+from ...core.artifact_type.patch import PackageJson, Patch, PyprojectToml
+from ...core.files import Files
+from ...core.version import version_to_pep_440
+from ..artifact_template import ArtifactTemplateGroup
+
+
+class DataApp(ArtifactTemplateGroup):
+
+    @property
+    def default_template(self) -> str:
+        return "streamlit"
+
+    @property
+    def template_group_directory(self) -> PathLike:
+        return Path(__file__).parent.joinpath("templates")
+
+    @property
+    def artifact_type(self) -> str:
+        return "data-app"
+
+    @property
+    def legacy_artifact_type(self) -> str:
+        return "connectors"
+
+    @property
+    def patches(self) -> list[Patch]:
+        return [PyprojectToml(), PackageJson()]
+
+    @staticmethod
+    def data_app_matches(artifact: ArtifactKey, data_app: dict) -> bool:
+        """
+        Check if a data app matches the artifact being unpublished.
+        Data apps have scope (namespace), version, and slug fields.
+        """
+        scope = data_app.get("scope", None)
+        slug = data_app.get("slug", None)
+        version = data_app.get("version", None)
+        return (
+            artifact.namespace == scope
+            and artifact.slug == slug
+            and artifact.version == version
+        )
+
+    def update_manifest(self, manifest: dict, artifact: ArtifactKey) -> None:
+        super().update_manifest(manifest, artifact)
+        manifest["type"] = "connector"
+
+    @property
+    def client_type(self) -> str:
+        return "data-app"
+
+    def get_dependents(self, artifact: ArtifactKey, api: TsApi) -> list[str]:
+        data_apps = []
+        next_page = 1
+        while next_page is not None:
+            page, next_page = api.data_apps.get_data_apps(page=next_page)
+            data_apps = data_apps + page
+
+        return [
+            f"data app: {app.get('name', 'Unknown')}"
+            for app in data_apps
+            if DataApp.data_app_matches(artifact, app)
+        ]
+
+    def validate_source(
+        self, path: PathLike, api_config: ApiConfigLike
+    ) -> ValidationResult:
+        # Check for image.tar (same as connector)
+        package_content = os.listdir(path)
+        if "image.tar" not in package_content:
+            return ValidationResult(
+                errors=[
+                    "Data app package must contain 'image.tar'. "
+                    "Build your data app first with: poetry run poe build-for-publish"
+                ]
+            )
+
+        # Check manifest has correct subtype label
+        manifest_path = Path(path, "manifest.json")
+        manifest = Files.json.load_dict(manifest_path) or {}
+        labels = manifest.get("labels", [])
+        labels = labels if isinstance(labels, list) else []
+        subtype_labels = [
+            label
+            for label in labels
+            if (isinstance(label, dict) and label.get("name") == "subtype")
+        ]
+
+        if not subtype_labels or subtype_labels[0].get("value") != "data-app":
+            return ValidationResult(
+                errors=[
+                    "Data app manifest must include label: "
+                    '{"name": "subtype", "value": "data-app"}'
+                ]
+            )
+        return ValidationResult()
+
+    @property
+    def max_size(self) -> float:
+        return float("inf")
+
+    def decorate_environment(self, environment: dict) -> dict:
+        data_app_group = environment.get("data_app")
+        namespace = data_app_group.get("namespace")
+        slug = data_app_group.get("slug")
+        artifact_version = data_app_group.get("version")
+        semver_version = artifact_version.removeprefix("v")
+        pep_440_version = version_to_pep_440(artifact_version)
+        package_directory = DataApp._data_app_package_dir(namespace, slug)
+        artifact_title = slug.replace("-", " ").title()
+        data_app_group.update(
+            {
+                "_artifact_title": artifact_title,
+                "_description": f"A {artifact_title} data app",
+                "_package_dir": package_directory,
+                "_package_name": package_directory.replace("_", "-"),
+                "_semver_version": semver_version,
+                "_pep_440_version": pep_440_version,
+            }
+        )
+        return environment
+
+    @staticmethod
+    def _data_app_package_dir(namespace: str, slug: str) -> str:
+        """Create the package directory name for data apps."""
+        slug_clean = slug.replace("-", "_")
+        if namespace == "common":
+            return f"ts_data_app_{slug_clean}"
+        namespace_clean = namespace.replace("-", "_")
+        return f"ts_{namespace_clean}_data_app_{slug_clean}"

ts_lib_artifacts/artifacts/data_app/templates/react/4.3/cookiecutter.json

@@ -0,0 +1,14 @@
+{
+    "_project_dir": "project",
+    "data_app": {
+        "namespace": "common",
+        "slug": "example",
+        "version": "v0.1.0",
+        "_artifact_title": "",
+        "_description": "",
+        "_package_dir": "",
+        "_package_name": "",
+        "_semver_version": "",
+        "_pep_440_version": ""
+    }
+}

ts_lib_artifacts/artifacts/data_app/templates/react/4.3/{{ cookiecutter._project_dir }}/.dockerignore

@@ -0,0 +1,10 @@
+*
+!package.json
+!yarn.lock
+!packages
+!manifest.json
+!conf
+!README.md
+!images
+!.yarnrc.yml
+cspell.json

ts_lib_artifacts/artifacts/data_app/templates/react/4.3/{{ cookiecutter._project_dir }}/.env.example

@@ -0,0 +1,15 @@
+# Server environment variables for local development
+#
+# SETUP: Copy this file to .env.server and populate with your values:
+#   cp .env.example .env.server
+#
+# NOTE: Do NOT include /v1 suffix in TDP_ENDPOINT
+
+TDP_ENDPOINT=https://api.tetrascience.com
+ORG_SLUG=your-org-slug
+
+# Extract from cookies in your browser:
+# 1. Open TDP in your browser and log in
+# 2. Open Developer Tools > Application > Cookies
+# 3. Find the 'ts_auth_token' cookie and copy its value here
+TS_AUTH_TOKEN=your-auth-token-here