Metadata-Version: 2.5
Name: workshopify
Version: 0.2.0
Summary: Skeleton and scaffolding for template-rendered, notebook-based workshop repositories
Project-URL: Repository, https://github.com/jkeifer/workshopify
Author-email: Jarrett Keifer <jkeifer0@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
Requires-Python: >=3.14
Requires-Dist: cogapp>=3.5.1
Requires-Dist: ipynb-scrubber>=0.5.0
Requires-Dist: jupytext>=1.19.4
Requires-Dist: tomlkit>=0.13.2
Description-Content-Type: text/markdown

# workshopify

Skeleton and scaffolding for template-rendered, notebook-based workshop
repositories.

A workshop repo declares everything mechanical in `[tool.workshopify]` tables
in its `pyproject.toml`, and workshopify does the rest:

| Command | Does |
| --- | --- |
| `workshopify render` | Re-render templated values and assets in place |
| `workshopify check` | Report stale rendered values or assets; exit 1 if any |
| `workshopify generate` | Generate the notebooks and notes from `src/` |
| `workshopify build` | Assemble the published workshop tree into its branch worktree |
| `workshopify set <key> <value>` | Set a `[tool.workshopify.params]` value and re-render |
| `workshopify worktree <branch>` | Prepare a branch worktree without building |

## Status

Extracted from a working workshop repository and being generalised. The
configuration contract and command surface are not yet documented in full and
are still subject to change.
