Skip to main content

Turn a sequence of app commands into an editable, re-renderable demo/tour artifact.

Project description

walkthru

Turn a sequence of application commands into an editable, re-renderable demo/tour artifact — and play that sequence while observers record video, draw visual cues, and narrate.

walkthru owns the representation (the Demo Document) and the playback/capture engine. It does not render the final video — it hands a validated artifact off to a renderer (the reelee ecosystem, Remotion, moviepy/ffmpeg, …). Owning representation, not pixels, is the load-bearing boundary of the whole design.

Two modes, one data model, one engine

  • Generative — an author supplies a Demo Document (commands + annotations); walkthru plays it while recording, with optional cues (highlight, spotlight, hotspot, callout, synthetic cursor), pauses, and narration.
  • Capture — a human operates the app manually; walkthru records the video and the underlying command stream and annotations, producing the same Demo Document.

The only difference between the modes is who fills in the document.

The core

play(demoDoc, executor, observers) -> Outcome

A pure higher-order function that walks the document and emits lifecycle events (onStepEnterbeforeCommandafterCommandonStepExit, onCueBegin/End, onNarration, …). It never records, renders, or speaks — every effect is an injected observer or port.

Ecosystem-biased, ecosystem-independent

The core and ports depend on nothing from our ecosystem. Integration with acture (the command layer), reelee (the renderer), and zodal ships as optional adapters. You can pip install walkthru / npm i acture-walkthru and use the core with your own adapters.

Packages

Package Registry Role
walkthru PyPI Python core + schema SSOT + render hand-off
acture-walkthru npm TS core + the live capture/play engine over acture

Status

🚧 Planning. See PLAN.md for the implementation plan, DECISIONS.md for design decisions and deviations from the brief, and the repo's enhancement issues for the running development journal. Source documents live in misc/docs/.

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

walkthru-0.0.7.tar.gz (126.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

walkthru-0.0.7-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

File details

Details for the file walkthru-0.0.7.tar.gz.

File metadata

  • Download URL: walkthru-0.0.7.tar.gz
  • Upload date:
  • Size: 126.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for walkthru-0.0.7.tar.gz
Algorithm Hash digest
SHA256 9ea415f2195994e8a7e4753aa29d796341e23ff8ae627e14475c6319a984e67a
MD5 adb09c92c7aca279d2822787d0ae6fc6
BLAKE2b-256 750f269fa59d24756c7024c9cbe3d1c2f33c79312da387bf3d516953cf97f95a

See more details on using hashes here.

File details

Details for the file walkthru-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: walkthru-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 31.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for walkthru-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 0393994da8384f852c0174245cf1dd887ac09d064707341b1c7ce977bc446d6c
MD5 48a37a89f9b5de92ff22040568f97d24
BLAKE2b-256 cc2f2a1a12d9974fcde4139a3c4a5f9d49bdd6afdbc8275ca7a927eaacbc52e1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page