Spec-driven presentation runtime
Project description
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 (Docusaurus + Sphinx API reference)
- ADR overview:
docs/README-deckicorn-adr.md - Presentation spec:
docs/SPEC-presentation-spec.md - Deckicorn MD dialect:
docs/SPEC-deckicorn-md-dialect.md - Deck project manifest:
docs/SPEC-deckicorn-project-manifest.md - Implementation plan:
plan/deckicorn-implementation-plan.md - AI workflow 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).
git checkout develop
Quick start
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):
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):
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.mdin Keep a Changelog format. - Curate
## [Unreleased]as release-relevant work lands. - Stage
CHANGELOG.mdwith any commit that changes other files (check-changeloghook).
Version source: root VERSION (kept in sync with pyproject.toml and deckicorn_spec.__version__ at release time).
Release workflow: 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 |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file deckicorn-0.2.0.tar.gz.
File metadata
- Download URL: deckicorn-0.2.0.tar.gz
- Upload date:
- Size: 25.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d6e01ecc8d4ae0c0eb9c4b8cf89b65629538713ac9be83b68ae9f673c491ed8d
|
|
| MD5 |
ce02196c1f56c2b5d8c70e5af6ef4cd1
|
|
| BLAKE2b-256 |
64fff2c2ea8bbf2ace0aea52cfb133274a97ec0590ad14066bd390b4105bd18a
|
File details
Details for the file deckicorn-0.2.0-py3-none-any.whl.
File metadata
- Download URL: deckicorn-0.2.0-py3-none-any.whl
- Upload date:
- Size: 26.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0ce24e681a1cdcef7218aa3b6ad6185164dc0773ba1c504c82f53f8077643cc8
|
|
| MD5 |
067b0280d9207e603d5a4c68c243d5c3
|
|
| BLAKE2b-256 |
7775c2a7d95219151b28592feffdd8ccbd3792bcf3560ac00988808d5d1c3f99
|