deckicorn 0.2.0__tar.gz

deckicorn-0.2.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: deckicorn
+Version: 0.2.0
+Summary: Spec-driven presentation runtime
+Project-URL: Documentation, https://deckicorn.org
+Project-URL: Repository, https://gitlab.com/libesys/deckicorn/deckicorn-cli
+Project-URL: Changelog, https://deckicorn.org/blog
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic>=2.0
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=4.0; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.4; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
+Provides-Extra: runtime
+Requires-Dist: arcade<4,>=3.0; extra == "runtime"
+Provides-Extra: packaging
+Requires-Dist: pyinstaller>=6.0; extra == "packaging"
+
+# Deckicorn
+
+Spec-driven presentation runtime: compile Markdown decks + layout YAML into a canonical presentation spec, then render with a 2D (Arcade) runtime.
+
+## Documentation
+
+- **Public site:** [deckicorn.org](https://deckicorn.org) (Docusaurus + Sphinx API reference)
+- ADR overview: [`docs/README-deckicorn-adr.md`](docs/README-deckicorn-adr.md)
+- Presentation spec: [`docs/SPEC-presentation-spec.md`](docs/SPEC-presentation-spec.md)
+- Deckicorn MD dialect: [`docs/SPEC-deckicorn-md-dialect.md`](docs/SPEC-deckicorn-md-dialect.md)
+- Deck project manifest: [`docs/SPEC-deckicorn-project-manifest.md`](docs/SPEC-deckicorn-project-manifest.md)
+- Implementation plan: [`plan/deckicorn-implementation-plan.md`](plan/deckicorn-implementation-plan.md)
+- AI workflow rules: [`tools/ai-rules/`](tools/ai-rules/)
+
+## Git workflow
+
+Day-to-day work happens on **`develop`**; **`master`** is ff-merged when Development CI is green (A2C `development-workflow.md`).
+
+```bash
+git checkout develop
+```
+
+## Quick start
+
+```bash
+pip install -e ".[dev]"
+pre-commit install
+pre-commit install --hook-type commit-msg
+```
+
+From a deck project directory (see `examples/deckicorn-hello/deckicorn.yaml`):
+
+```bash
+cd examples/deckicorn-hello
+deckicorn build
+deckicorn preview          # requires pip install -e ".[runtime]"
+deckicorn preview --show-bounds
+deckicorn package --clean  # requires pip install -e ".[runtime,packaging]"
+```
+
+Ad hoc paths (without `deckicorn.yaml`):
+
+```bash
+deckicorn build examples/deckicorn-hello/deck.md \
+  --layout examples/deckicorn-hello/layout-default.yaml \
+  --out examples/deckicorn-hello/build/deck-spec.yaml
+deckicorn run examples/deckicorn-hello/build/deck-spec.yaml
+```
+
+## Changelog and pre-commit
+
+This repository follows A2C changelog policy (`tools/ai-rules/rules/11-changelog-policy.md`):
+
+- Maintain `CHANGELOG.md` in [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.
+- Curate `## [Unreleased]` as release-relevant work lands.
+- Stage `CHANGELOG.md` with any commit that changes other files (`check-changelog` hook).
+
+Version source: root `VERSION` (kept in sync with `pyproject.toml` and `deckicorn_spec.__version__` at release time).
+
+Release workflow: [docs/release-pipeline.md](docs/release-pipeline.md).
+
+## Project layout
+
+| Path | Purpose |
+|------|---------|
+| `docs/` | ADRs and specs (canonical) |
+| `inputs/` | Read-only intake copies of source docs |
+| `deckicorn-spec` (`src/deckicorn_spec`) | Presentation spec models and validation |
+| `deckicorn-md` (`src/deckicorn_md`) | Deckicorn MD parser and compiler |
+| `deckicorn-runtime` (`src/deckicorn_runtime`) | Presentation runtime |
+| `examples/` | Documented deck projects (`deckicorn-hello/`, …) |
+| `tests/fixtures/decks/` | Broken manifest fixtures for CI and unit tests |

deckicorn-0.2.0/README.md

@@ -0,0 +1,72 @@
+# Deckicorn
+
+Spec-driven presentation runtime: compile Markdown decks + layout YAML into a canonical presentation spec, then render with a 2D (Arcade) runtime.
+
+## Documentation
+
+- **Public site:** [deckicorn.org](https://deckicorn.org) (Docusaurus + Sphinx API reference)
+- ADR overview: [`docs/README-deckicorn-adr.md`](docs/README-deckicorn-adr.md)
+- Presentation spec: [`docs/SPEC-presentation-spec.md`](docs/SPEC-presentation-spec.md)
+- Deckicorn MD dialect: [`docs/SPEC-deckicorn-md-dialect.md`](docs/SPEC-deckicorn-md-dialect.md)
+- Deck project manifest: [`docs/SPEC-deckicorn-project-manifest.md`](docs/SPEC-deckicorn-project-manifest.md)
+- Implementation plan: [`plan/deckicorn-implementation-plan.md`](plan/deckicorn-implementation-plan.md)
+- AI workflow rules: [`tools/ai-rules/`](tools/ai-rules/)
+
+## Git workflow
+
+Day-to-day work happens on **`develop`**; **`master`** is ff-merged when Development CI is green (A2C `development-workflow.md`).
+
+```bash
+git checkout develop
+```
+
+## Quick start
+
+```bash
+pip install -e ".[dev]"
+pre-commit install
+pre-commit install --hook-type commit-msg
+```
+
+From a deck project directory (see `examples/deckicorn-hello/deckicorn.yaml`):
+
+```bash
+cd examples/deckicorn-hello
+deckicorn build
+deckicorn preview          # requires pip install -e ".[runtime]"
+deckicorn preview --show-bounds
+deckicorn package --clean  # requires pip install -e ".[runtime,packaging]"
+```
+
+Ad hoc paths (without `deckicorn.yaml`):
+
+```bash
+deckicorn build examples/deckicorn-hello/deck.md \
+  --layout examples/deckicorn-hello/layout-default.yaml \
+  --out examples/deckicorn-hello/build/deck-spec.yaml
+deckicorn run examples/deckicorn-hello/build/deck-spec.yaml
+```
+
+## Changelog and pre-commit
+
+This repository follows A2C changelog policy (`tools/ai-rules/rules/11-changelog-policy.md`):
+
+- Maintain `CHANGELOG.md` in [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.
+- Curate `## [Unreleased]` as release-relevant work lands.
+- Stage `CHANGELOG.md` with any commit that changes other files (`check-changelog` hook).
+
+Version source: root `VERSION` (kept in sync with `pyproject.toml` and `deckicorn_spec.__version__` at release time).
+
+Release workflow: [docs/release-pipeline.md](docs/release-pipeline.md).
+
+## Project layout
+
+| Path | Purpose |
+|------|---------|
+| `docs/` | ADRs and specs (canonical) |
+| `inputs/` | Read-only intake copies of source docs |
+| `deckicorn-spec` (`src/deckicorn_spec`) | Presentation spec models and validation |
+| `deckicorn-md` (`src/deckicorn_md`) | Deckicorn MD parser and compiler |
+| `deckicorn-runtime` (`src/deckicorn_runtime`) | Presentation runtime |
+| `examples/` | Documented deck projects (`deckicorn-hello/`, …) |
+| `tests/fixtures/decks/` | Broken manifest fixtures for CI and unit tests |

deckicorn-0.2.0/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "deckicorn"
+version = "0.2.0"
+description = "Spec-driven presentation runtime"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "pydantic>=2.0",
+    "PyYAML>=6.0",
+]
+
+[project.urls]
+Documentation = "https://deckicorn.org"
+Repository = "https://gitlab.com/libesys/deckicorn/deckicorn-cli"
+Changelog = "https://deckicorn.org/blog"
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit>=4.0",
+    "pytest>=8.0",
+    "ruff>=0.8",
+    "build>=1.0",
+    "twine>=5.0",
+]
+docs = [
+    "sphinx>=7.4",
+    "sphinx-rtd-theme>=2.0",
+]
+runtime = [
+    "arcade>=3.0,<4",
+]
+packaging = [
+    "pyinstaller>=6.0",
+]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[project.scripts]
+deckicorn = "deckicorn_cli.main:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

deckicorn-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

deckicorn-0.2.0/src/deckicorn.egg-info/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: deckicorn
+Version: 0.2.0
+Summary: Spec-driven presentation runtime
+Project-URL: Documentation, https://deckicorn.org
+Project-URL: Repository, https://gitlab.com/libesys/deckicorn/deckicorn-cli
+Project-URL: Changelog, https://deckicorn.org/blog
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic>=2.0
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=4.0; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.4; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
+Provides-Extra: runtime
+Requires-Dist: arcade<4,>=3.0; extra == "runtime"
+Provides-Extra: packaging
+Requires-Dist: pyinstaller>=6.0; extra == "packaging"
+
+# Deckicorn
+
+Spec-driven presentation runtime: compile Markdown decks + layout YAML into a canonical presentation spec, then render with a 2D (Arcade) runtime.
+
+## Documentation
+
+- **Public site:** [deckicorn.org](https://deckicorn.org) (Docusaurus + Sphinx API reference)
+- ADR overview: [`docs/README-deckicorn-adr.md`](docs/README-deckicorn-adr.md)
+- Presentation spec: [`docs/SPEC-presentation-spec.md`](docs/SPEC-presentation-spec.md)
+- Deckicorn MD dialect: [`docs/SPEC-deckicorn-md-dialect.md`](docs/SPEC-deckicorn-md-dialect.md)
+- Deck project manifest: [`docs/SPEC-deckicorn-project-manifest.md`](docs/SPEC-deckicorn-project-manifest.md)
+- Implementation plan: [`plan/deckicorn-implementation-plan.md`](plan/deckicorn-implementation-plan.md)
+- AI workflow rules: [`tools/ai-rules/`](tools/ai-rules/)
+
+## Git workflow
+
+Day-to-day work happens on **`develop`**; **`master`** is ff-merged when Development CI is green (A2C `development-workflow.md`).
+
+```bash
+git checkout develop
+```
+
+## Quick start
+
+```bash
+pip install -e ".[dev]"
+pre-commit install
+pre-commit install --hook-type commit-msg
+```
+
+From a deck project directory (see `examples/deckicorn-hello/deckicorn.yaml`):
+
+```bash
+cd examples/deckicorn-hello
+deckicorn build
+deckicorn preview          # requires pip install -e ".[runtime]"
+deckicorn preview --show-bounds
+deckicorn package --clean  # requires pip install -e ".[runtime,packaging]"
+```
+
+Ad hoc paths (without `deckicorn.yaml`):
+
+```bash
+deckicorn build examples/deckicorn-hello/deck.md \
+  --layout examples/deckicorn-hello/layout-default.yaml \
+  --out examples/deckicorn-hello/build/deck-spec.yaml
+deckicorn run examples/deckicorn-hello/build/deck-spec.yaml
+```
+
+## Changelog and pre-commit
+
+This repository follows A2C changelog policy (`tools/ai-rules/rules/11-changelog-policy.md`):
+
+- Maintain `CHANGELOG.md` in [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.
+- Curate `## [Unreleased]` as release-relevant work lands.
+- Stage `CHANGELOG.md` with any commit that changes other files (`check-changelog` hook).
+
+Version source: root `VERSION` (kept in sync with `pyproject.toml` and `deckicorn_spec.__version__` at release time).
+
+Release workflow: [docs/release-pipeline.md](docs/release-pipeline.md).
+
+## Project layout
+
+| Path | Purpose |
+|------|---------|
+| `docs/` | ADRs and specs (canonical) |
+| `inputs/` | Read-only intake copies of source docs |
+| `deckicorn-spec` (`src/deckicorn_spec`) | Presentation spec models and validation |
+| `deckicorn-md` (`src/deckicorn_md`) | Deckicorn MD parser and compiler |
+| `deckicorn-runtime` (`src/deckicorn_runtime`) | Presentation runtime |
+| `examples/` | Documented deck projects (`deckicorn-hello/`, …) |
+| `tests/fixtures/decks/` | Broken manifest fixtures for CI and unit tests |

deckicorn-0.2.0/src/deckicorn.egg-info/SOURCES.txt

@@ -0,0 +1,42 @@
+README.md
+pyproject.toml
+src/deckicorn.egg-info/PKG-INFO
+src/deckicorn.egg-info/SOURCES.txt
+src/deckicorn.egg-info/dependency_links.txt
+src/deckicorn.egg-info/entry_points.txt
+src/deckicorn.egg-info/requires.txt
+src/deckicorn.egg-info/top_level.txt
+src/deckicorn_cli/main.py
+src/deckicorn_md/__init__.py
+src/deckicorn_md/compiler.py
+src/deckicorn_md/parser.py
+src/deckicorn_project/__init__.py
+src/deckicorn_project/manifest.py
+src/deckicorn_project/packaging.py
+src/deckicorn_project/pyinstaller/hooks/hook-arcade.py
+src/deckicorn_runtime/__init__.py
+src/deckicorn_runtime/arcade_app.py
+src/deckicorn_runtime/bounds_overlay.py
+src/deckicorn_runtime/console.py
+src/deckicorn_runtime/coords.py
+src/deckicorn_runtime/navigation.py
+src/deckicorn_runtime/preview_options.py
+src/deckicorn_runtime/resources.py
+src/deckicorn_spec/__init__.py
+src/deckicorn_spec/io.py
+src/deckicorn_spec/models.py
+src/deckicorn_spec/validate.py
+tests/test_cli_project.py
+tests/test_compiler.py
+tests/test_packaging.py
+tests/test_preview_options.py
+tests/test_project_manifest.py
+tests/test_registry_publish.py
+tests/test_release_ci_gates.py
+tests/test_release_version.py
+tests/test_runtime.py
+tests/test_runtime_coords.py
+tests/test_runtime_navigation.py
+tests/test_spec_models.py
+tests/test_verify_release_ready.py
+tests/test_verify_release_version.py

deckicorn-0.2.0/src/deckicorn.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

deckicorn-0.2.0/src/deckicorn.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+deckicorn = deckicorn_cli.main:main

deckicorn-0.2.0/src/deckicorn.egg-info/requires.txt

@@ -0,0 +1,19 @@
+pydantic>=2.0
+PyYAML>=6.0
+
+[dev]
+pre-commit>=4.0
+pytest>=8.0
+ruff>=0.8
+build>=1.0
+twine>=5.0
+
+[docs]
+sphinx>=7.4
+sphinx-rtd-theme>=2.0
+
+[packaging]
+pyinstaller>=6.0
+
+[runtime]
+arcade<4,>=3.0

deckicorn-0.2.0/src/deckicorn.egg-info/top_level.txt

@@ -0,0 +1,5 @@
+deckicorn_cli
+deckicorn_md
+deckicorn_project
+deckicorn_runtime
+deckicorn_spec

deckicorn-0.2.0/src/deckicorn_cli/main.py

@@ -0,0 +1,155 @@
+"""Deckicorn toolchain CLI (ADR-019)."""
+
+from __future__ import annotations
+
+import argparse
+from pathlib import Path
+
+from deckicorn_md.compiler import compile_files
+from deckicorn_project.manifest import (
+    MANIFEST_NAME,
+    ensure_paths_exist,
+    load_project,
+    resolve_project_root,
+)
+from deckicorn_project.packaging import package_presentation
+from deckicorn_runtime.console import run_presentation_file as run_console_presentation_file
+from deckicorn_runtime.preview_options import add_preview_arguments
+from deckicorn_spec.io import save_presentation_file
+
+
+def _add_project_arg(parser: argparse.ArgumentParser) -> None:
+    parser.add_argument(
+        "--project",
+        type=Path,
+        default=None,
+        help="Deck project root containing deckicorn.yaml (default: current directory)",
+    )
+
+
+def _load_resolved(args: argparse.Namespace):
+    root = resolve_project_root(args.project)
+    return load_project(root)
+
+
+def _manifest_available(project: Path | None = None) -> bool:
+    root = (project or Path.cwd()).resolve()
+    return (root / MANIFEST_NAME).is_file()
+
+
+def _cmd_build(args: argparse.Namespace) -> int:
+    if args.md is not None:
+        if not args.layout or not args.out:
+            raise SystemExit("build requires --layout and --out when not using a deck project")
+        md_path = Path(args.md)
+        layout_path = Path(args.layout)
+        out_path = Path(args.out)
+    else:
+        project = _load_resolved(args)
+        ensure_paths_exist(project)
+        md_path = project.content
+        layout_path = project.layout
+        out_path = project.build_spec
+
+    presentation = compile_files(md_path, layout_path)
+    out_path.parent.mkdir(parents=True, exist_ok=True)
+    save_presentation_file(presentation, out_path)
+    print(f"Wrote {out_path}")
+    return 0
+
+
+def _cmd_run(args: argparse.Namespace) -> int:
+    if args.spec is not None:
+        spec_path = Path(args.spec)
+    else:
+        project = _load_resolved(args)
+        ensure_paths_exist(project, need_spec=True)
+        spec_path = project.build_spec
+
+    run_console_presentation_file(str(spec_path))
+    return 0
+
+
+def _cmd_preview(args: argparse.Namespace) -> int:
+    from deckicorn_runtime.arcade_app import run_arcade_presentation
+    from deckicorn_runtime.preview_options import preview_options_from_args, profile_bounds_defaults
+
+    bounds_style = profile_bounds_defaults("minimal")
+    if args.spec is not None:
+        spec_path = Path(args.spec)
+        asset_root = spec_path.parent
+    else:
+        project = _load_resolved(args)
+        ensure_paths_exist(project, need_spec=True)
+        spec_path = project.build_spec
+        asset_root = project.root
+        bounds_style = project.preview_bounds
+
+    options = preview_options_from_args(args, bounds=bounds_style)
+    run_arcade_presentation(
+        spec_path,
+        asset_root=asset_root,
+        width=options.width,
+        height=options.height,
+        show_element_bounds=options.show_bounds,
+        bounds_style=options.bounds,
+    )
+    return 0
+
+
+def _cmd_package(args: argparse.Namespace) -> int:
+    project = _load_resolved(args)
+    binary = package_presentation(project, clean=args.clean)
+    print(f"Built {binary}")
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(prog="deckicorn", description="Deckicorn toolchain CLI")
+    sub = parser.add_subparsers(dest="command", required=True)
+
+    build = sub.add_parser("build", help="Compile MD + layout into presentation spec YAML")
+    build.add_argument("md", nargs="?", help="Deckicorn MD deck file")
+    build.add_argument("--layout", help="Layout overlay YAML")
+    build.add_argument("--out", help="Output presentation spec YAML")
+    _add_project_arg(build)
+    build.set_defaults(func=_cmd_build)
+
+    run = sub.add_parser("run", help="Run a presentation spec (console mode)")
+    run.add_argument("spec", nargs="?", help="Presentation spec YAML")
+    _add_project_arg(run)
+    run.set_defaults(func=_cmd_run)
+
+    preview = sub.add_parser("preview", help="Preview a presentation spec in an Arcade window")
+    preview.add_argument("spec", nargs="?", help="Presentation spec YAML")
+    add_preview_arguments(preview)
+    _add_project_arg(preview)
+    preview.set_defaults(func=_cmd_preview)
+
+    package = sub.add_parser("package", help="Package a deck project into a standalone executable")
+    package.add_argument("--clean", action="store_true", help="Remove prior build artifacts first")
+    _add_project_arg(package)
+    package.set_defaults(func=_cmd_package)
+
+    args = parser.parse_args(argv)
+
+    if args.command == "build" and args.md is None and not _manifest_available(args.project):
+        parser.error(
+            "build requires a deck MD path, or run from a directory containing deckicorn.yaml "
+            "(or pass --project)",
+        )
+    if (
+        args.command in {"run", "preview"}
+        and getattr(args, "spec", None) is None
+        and not _manifest_available(args.project)
+    ):
+        parser.error(
+            f"{args.command} requires a spec path, or run from a directory containing "
+            "deckicorn.yaml (or pass --project)",
+        )
+
+    return args.func(args)
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

deckicorn-0.2.0/src/deckicorn_md/__init__.py

@@ -0,0 +1,12 @@
+"""Deckicorn MD parser and compiler (ADR-013)."""
+
+from deckicorn_md.compiler import compile_files, compile_presentation
+from deckicorn_md.parser import ContentDeck, parse_deckicorn_md, parse_deckicorn_md_file
+
+__all__ = [
+    "ContentDeck",
+    "compile_files",
+    "compile_presentation",
+    "parse_deckicorn_md",
+    "parse_deckicorn_md_file",
+]