heritage-cli 1.0.0__tar.gz → 1.0.2__tar.gz

heritage_cli-1.0.2/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: heritage-cli
+Version: 1.0.2
+Summary: Unified CLI for the heritage science open-source ecosystem — orchestrates HOARD, StratiGraph, Trowel, Libby, Dibble, and other tools
+Author: Mark Bouck
+License: MIT
+Requires-Python: >=3.11
+Requires-Dist: typer>=0.12
+Requires-Dist: rich>=13
+Requires-Dist: pyyaml>=6
+Provides-Extra: hoard
+Requires-Dist: hoard; extra == "hoard"
+Provides-Extra: libby
+Requires-Dist: libby; extra == "libby"
+Provides-Extra: dibble
+Requires-Dist: dibble; extra == "dibble"
+Provides-Extra: trowel
+Requires-Dist: trowel; extra == "trowel"
+Provides-Extra: stratigraph
+Requires-Dist: stratigraph; extra == "stratigraph"

heritage_cli-1.0.2/README.md

@@ -0,0 +1,141 @@
+# heritage-cli
+
+Unified command-line orchestrator for the heritage science open-source ecosystem. Runs multi-tool archaeological workflows as a single command.
+
+## What It Does
+
+`heritage` is a thin orchestration layer. It reads a declarative `pipeline.yaml` file and invokes HOARD, StratiGraph, Libby, and other tools in the correct order, passing workspace paths between them and pausing at human review gates.
+
+It does **not** do any data processing itself — that stays in the individual tools.
+
+## Installation
+
+```bash
+pip install heritage-cli
+```
+
+Requires the tools you intend to use to also be installed (`hoard`, `libby`, etc.).
+
+Or install with specific tool dependencies:
+
+```bash
+pip install heritage-cli[hoard,libby,stratigraph,dibble,trowel]
+```
+
+Install all ecosystem tools at once:
+
+```bash
+pip install heritage-cli[hoard,libby,stratigraph,dibble,trowel]
+```
+
+## Usage
+
+```bash
+# Run a full pipeline from a definition file
+heritage run --pipeline pipeline.yaml --project my_site_2026
+
+# If interrupted, heritage automatically resumes from the last completed step
+
+# List installed and discoverable heritage tools
+heritage tools
+
+# Run tools individually (requires the tool to be installed)
+heritage calibrate --project my_site_2026
+heritage lithics --project my_site_2026
+heritage review --project my_site_2026
+heritage matrix --project my_site_2026
+heritage publish --project my_site_2026
+```
+
+## Pipeline Definition
+
+See `pipeline.example.yaml` for a full example. The basic structure:
+
+```yaml
+steps:
+  - id: digitise
+    project: hoard
+    phases: [0, 1]
+
+  - id: review_digitisation
+    gate: review
+    message: "Review digitised context sheets before proceeding"
+    action: "hoard review --project {project_id}"
+    depends_on: [digitise]
+
+  - id: spatial
+    project: hoard
+    phases: [2]
+    depends_on: [review_digitisation]
+
+  - id: calibrate
+    project: libby
+    action: calibrate
+    input: output/01_digitised/samples.json
+    depends_on: [review_digitisation]
+
+  - id: draft
+    project: hoard
+    phases: [3, 4]
+    depends_on: [spatial, calibrate]
+
+  - id: review_draft
+    gate: review
+    message: "Review the draft before final export"
+    depends_on: [draft]
+
+  - id: export
+    project: hoard
+    action: export
+    formats: [docx, pdf]
+    depends_on: [review_draft]
+```
+
+## Pipeline State
+
+Progress is saved to `$XDG_DATA_HOME/heritage/workspaces/{project_id}/pipeline_state.json`. If a run is interrupted, the next `heritage run` invocation automatically resumes from the last completed step.
+
+## Ecosystem
+
+`heritage-cli` is part of a wider open-source heritage science toolkit:
+
+| Tool | Purpose |
+|------|---------|
+| [hoard](https://github.com/mabo-du/hoard) | AI-powered archaeological report generation |
+| [stratigraph](https://github.com/mabo-du/stratigraph) | Harris Matrix visualisation |
+| [libby](https://github.com/mabo-du/libby) | Radiocarbon calibration |
+| [cache-and-carry](https://github.com/mabo-du/cache-and-carry) | Collections & vocabulary management |
+| [heritage-types](https://github.com/mabo-du/heritage-types) | Shared data schemas |
+
+## Status
+
+| Command | Status |
+|---------|--------|
+| `heritage run` | ✅ Implemented |
+| `heritage calibrate` | ✅ Implemented |
+| `heritage lithics` | ✅ Implemented |
+| `heritage review` | ✅ Implemented |
+| `heritage matrix` | ✅ Implemented |
+| `heritage publish` | ✅ Implemented |
+| `heritage tools` | ✅ Implemented |
+| `heritage pipeline-status` | ✅ Implemented |
+
+## License
+
+MIT
+
+## Development
+
+```bash
+# Clone and install in dev mode
+pip install -e ".[dev]"
+
+# Run unit tests (no sibling packages required)
+python -m pytest tests/ -v -m "not integration"
+
+# Run all tests including integration (requires hoard installed)
+python -m pytest tests/ -v
+
+# Type check
+mypy src/
+```

{heritage_cli-1.0.0 → heritage_cli-1.0.2}/pyproject.toml

@@ -4,20 +4,26 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "heritage-cli"
-version = "1.0.0"
+version = "1.0.2"
 description = "Unified CLI for the heritage science open-source ecosystem — orchestrates HOARD, StratiGraph, Trowel, Libby, Dibble, and other tools"
 requires-python = ">=3.11"
 license = { text = "MIT" }
 authors = [
-    { name = "Marcus Quinn" },
+    { name = "Mark Bouck" },
 ]
 dependencies = [
     "typer>=0.12",
     "rich>=13",
-    "platformdirs>=4",
-    "tomli>=2; python_version < '3.11'",
+    "pyyaml>=6",
 ]
 
+[project.optional-dependencies]
+hoard = ["hoard"]
+libby = ["libby"]
+dibble = ["dibble"]
+trowel = ["trowel"]
+stratigraph = ["stratigraph"]
+
 [project.scripts]
 heritage = "heritage_cli.main:app"
 
@@ -30,3 +36,14 @@ dibble = "heritage_cli.commands.dibble"
 
 [tool.setuptools.packages.find]
 where = ["src"]
+
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+markers = [
+    "integration: tests that require sibling ecosystem packages to be installed",
+]

{heritage_cli-1.0.0 → heritage_cli-1.0.2}/src/heritage_cli/__init__.py

@@ -13,9 +13,14 @@ Usage:
     heritage --help
     heritage run --project X --phase 0
     heritage calibrate --project X --input samples.json
-    heritage tools list
+    heritage tools     → list installed ecosystem tools
 
 Configuration: ~/.config/heritage/config.toml
 """
 
-__version__ = "1.0.0"
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("heritage-cli")
+except PackageNotFoundError:
+    __version__ = "1.0.0"

heritage_cli-1.0.2/src/heritage_cli/commands/dibble.py

@@ -0,0 +1,27 @@
+"""Dibble command dispatch — Lithic analysis.
+
+Registered as heritage_cli.commands.dibble in entry_points.
+"""
+
+tool_name = "dibble"
+description = "Lithic analysis"
+
+
+def dispatch(args: list[str] | None = None) -> int:
+    """Run dibble with the given CLI arguments.
+
+    Returns subprocess exit code.
+    """
+    import shutil
+    import subprocess
+    import sys
+
+    dibble_bin = shutil.which("dibble")
+    if not dibble_bin:
+        sys.stderr.write("Dibble is not installed.\n")
+        sys.stderr.write("Install with: pip install dibble\n")
+        return 1
+
+    cmd = [dibble_bin] + (args or sys.argv[2:])
+    result = subprocess.run(cmd, check=True)
+    return result.returncode

{heritage_cli-1.0.0 → heritage_cli-1.0.2}/src/heritage_cli/commands/hoard.py

@@ -14,6 +14,7 @@ def dispatch(args: list[str] | None = None) -> int:
     """
     import subprocess
     import sys
+
     cmd = ["hoard"] + (args or sys.argv[2:])
-    result = subprocess.run(cmd)
+    result = subprocess.run(cmd, check=True, timeout=3600)
     return result.returncode

heritage_cli-1.0.2/src/heritage_cli/commands/libby.py

@@ -0,0 +1,27 @@
+"""Libby command dispatch — Radiocarbon calibration.
+
+Registered as heritage_cli.commands.libby in entry_points.
+"""
+
+tool_name = "libby"
+description = "Radiocarbon calibration"
+
+
+def dispatch(args: list[str] | None = None) -> int:
+    """Run libby with the given CLI arguments.
+
+    Returns subprocess exit code.
+    """
+    import shutil
+    import subprocess
+    import sys
+
+    libby_bin = shutil.which("libby")
+    if not libby_bin:
+        sys.stderr.write("Libby is not installed.\n")
+        sys.stderr.write("Install with: pip install libby\n")
+        return 1
+
+    cmd = [libby_bin] + (args or sys.argv[2:])
+    result = subprocess.run(cmd, check=True)
+    return result.returncode

heritage_cli-1.0.2/src/heritage_cli/commands/stratigraph.py

@@ -0,0 +1,27 @@
+"""StratiGraph command dispatch — Harris Matrix visualisation.
+
+Registered as heritage_cli.commands.stratigraph in entry_points.
+"""
+
+tool_name = "stratigraph"
+description = "Harris Matrix visualisation and validation"
+
+
+def dispatch(args: list[str] | None = None) -> int:
+    """Run stratigraph with the given CLI arguments.
+
+    Returns subprocess exit code.
+    """
+    import shutil
+    import subprocess
+    import sys
+
+    stratigraph_bin = shutil.which("stratigraph")
+    if not stratigraph_bin:
+        sys.stderr.write("StratiGraph is not installed.\n")
+        sys.stderr.write("Install from: https://github.com/mabo-du/stratigraph\n")
+        return 1
+
+    cmd = [stratigraph_bin] + (args or sys.argv[2:])
+    result = subprocess.run(cmd, check=True)
+    return result.returncode

heritage_cli-1.0.2/src/heritage_cli/commands/trowel.py

@@ -0,0 +1,27 @@
+"""Trowel command dispatch — Desktop report review dashboard.
+
+Registered as heritage_cli.commands.trowel in entry_points.
+"""
+
+tool_name = "trowel"
+description = "Desktop report review dashboard"
+
+
+def dispatch(args: list[str] | None = None) -> int:
+    """Run trowel with the given CLI arguments.
+
+    Returns subprocess exit code.
+    """
+    import shutil
+    import subprocess
+    import sys
+
+    trowel_bin = shutil.which("trowel")
+    if not trowel_bin:
+        sys.stderr.write("Trowel is not installed.\n")
+        sys.stderr.write("Install from: https://github.com/mabo-du/trowel\n")
+        return 1
+
+    cmd = [trowel_bin] + (args or sys.argv[2:])
+    result = subprocess.run(cmd, check=True)
+    return result.returncode