zettcode-presenters 0.4.0__tar.gz

zettcode_presenters-0.4.0/.gitignore

@@ -0,0 +1,37 @@
+**/.venv/
+**/__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.smoke/
+.coverage
+**/.pytest_cache/
+**/.ruff_cache/
+.zett-tool-output/
+.env
+.DS_Store
+
+# viztracer writes its trace here by default.
+/result.json
+
+# The docs site: dependencies, build output, and VitePress' cache.
+node_modules/
+docs/.vitepress/dist/
+docs/.vitepress/cache/
+docs/.vitepress/.temp/
+
+# The TypeScript client is built from its sources; only dist/ is published.
+clients/typescript/dist/
+
+# The gateway's page is built from clients/gateway into the package when a distribution is made (`make gateway-ui`);
+# the build output is not kept in the repository. pyproject's `artifacts` puts it in the wheel all the same.
+packages/zettcode-gateway/src/zettcode/gateway/static/
+
+# The palette gallery is generated by `make palettes`: every widget painted in
+# every palette, written by docs/scripts/palette_gallery.py. Regenerate it
+# rather than committing a 2 MB copy that goes stale the moment a colour moves.
+docs/internal/palettes.html
+
+# The release order is generated from the pyproject.toml files (`make order`); it is not kept in git.
+packages/order.txt

zettcode_presenters-0.4.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.5
+Name: zettcode-presenters
+Version: 0.4.0
+Summary: The conversation's rows and how ZettCode's terminal draws them
+Project-URL: Repository, https://github.com/Chang-LeHung/zettcode
+Author: Chang-LeHung
+License-Expression: MIT
+Keywords: presenters,transcript,zettcode
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: zettcode-plugin-api
+Requires-Dist: zettcode-tui
+Provides-Extra: types
+Requires-Dist: zettcode-sdk; extra == 'types'

zettcode_presenters-0.4.0/pyproject.toml

@@ -0,0 +1,52 @@
+[project]
+name = "zettcode-presenters"
+description = "The conversation's rows and how ZettCode's terminal draws them"
+requires-python = ">=3.10"
+dynamic = ["version"]
+license = "MIT"
+authors = [{name = "Chang-LeHung"}]
+keywords = ["zettcode", "presenters", "transcript"]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
+  "Typing :: Typed",
+]
+dependencies = [
+  # Written against the plugin contract, which is where the row model and the presenter base class are defined.
+  "zettcode-plugin-api",
+  "zettcode-tui",
+]
+
+[project.optional-dependencies]
+# The wording reads `Usage` figures the SDK defines; it is imported for the annotation only.
+types = ["zettcode-sdk"]
+
+# A part of the program, not a plugin: the `zettcode.plugins` group is what the plugin release line looks for.
+[project.entry-points."zettcode.terminal"]
+presenters = "zettcode.presenters.plugin:PresentersPlugin"
+
+[project.urls]
+Repository = "https://github.com/Chang-LeHung/zettcode"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+# One version for the whole repository: the engine ships the file.
+path = "../zettcode-engine/src/zettcode/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/zettcode"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/src", "/pyproject.toml"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"

zettcode_presenters-0.4.0/src/zettcode/presenters/__init__.py

@@ -0,0 +1,17 @@
+"""The conversation's rows and how the terminal draws them.
+
+`entries` is the data — one class per kind of row a transcript can hold — and `presenters` is how one kind becomes
+lines: a presenter per kind, the families inside a kind (a tool, a change, a relayed message), and the registry that
+picks between them. `brand` is the pixel art the welcome row draws.
+
+The terminal's transcript, the projector that fills it and the replay that rebuilds it stay in `zettcode.app`: this
+distribution is the part of them that a plugin replaces — a front end registers its own presenter through
+`ctx.tui.register_presenter`, and `zettcode-plugin-api` re-exports `Entry` and `Presenter` so it can.
+
+The plugin that registers the built-ins lives in the program (`zettcode.app.plugins.builtins`), because drawing a row
+is a terminal hook and the terminal's plugin base is there; it reads `presenters.BUILTIN_PRESENTERS`, so the program
+installs them the way it installs every other built-in — by listing it, never by discovering it — and `[plugins]
+disable` has nothing to name.
+"""
+
+from __future__ import annotations

zettcode_presenters-0.4.0/src/zettcode/presenters/brand.py

@@ -0,0 +1,43 @@
+"""The pixel robot shared by the terminal banner and documentation assets.
+
+Each character is one square pixel: frame, ear, dark face, eye, or heart;
+``.`` is transparent. One fifteen-by-ten map drives every rendering; the
+terminal holds two vertically stacked pixels per cell for a five-row mark,
+and the documentation scales those same pixels without resampling them.
+The brand colours stay fixed in both themes; only the surrounding text follows
+the reader's palette.
+"""
+
+from __future__ import annotations
+
+from zettcode.plugin_api.pets import pixel_lines
+from zettcode.tui.render.style import TextLine
+
+LOGO_PALETTE: dict[str, str] = {
+    "F": "#84b795",
+    "E": "#558967",
+    "D": "#263d34",
+    "I": "#b9dfb3",
+    "H": "#e4b47c",
+}
+
+LOGO_PIXELS: tuple[str, ...] = (
+    "..FFFFFFFFFFF..",
+    ".FFFFFFFFFFFFF.",
+    "EFFDIIDDDIIDFFE",
+    "EFFDIIDDDIIDFFE",
+    "EFFDDDDDDDDDFFE",
+    "EFFDDHHDHHDDFFE",
+    "EFFDDHHHHHDDFFE",
+    "EFFDDDDHDDDDFFE",
+    ".FFFFFFFFFFFFF.",
+    "..FFFFFFFFFFF..",
+)
+
+
+def logo_lines() -> tuple[TextLine, ...]:
+    """Return the full-size mark: :data:`LOGO_PIXELS` in :data:`LOGO_PALETTE`, five rows of cells."""
+    return pixel_lines(LOGO_PIXELS, LOGO_PALETTE)
+
+
+LOGO_LINES: tuple[TextLine, ...] = logo_lines()

zettcode_presenters-0.4.0/src/zettcode/presenters/plugin.py

@@ -0,0 +1,35 @@
+"""The plugin that offers the program's own row drawing to the terminal.
+
+It is an ordinary plugin, found through the ``zettcode.plugins`` entry point like any other, and the terminal lists it
+as required: the program does not start without it, and ``[plugins] disable`` does not reach it. It needs nothing
+else, and the plugins that draw more kinds of row depend on it (``deps = ("presenters",)``) so theirs register after.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from zettcode.plugin_api.plugin import TuiPlugin
+from zettcode.presenters.presenters import BUILTIN_PRESENTERS
+
+if TYPE_CHECKING:  # pragma: no cover - annotations only
+    from zettcode.plugin_api import PluginContext
+
+
+class PresentersPlugin(TuiPlugin):
+    """How the program draws its own rows, offered the way any plugin offers a presenter.
+
+    They register at the priority their class declares, which is the lowest there is, so a plugin that draws the same
+    kind or family wins without having to outrank them. Adding a built-in kind of row is adding a presenter to
+    ``BUNDLED`` in the conversation and nothing here.
+    """
+
+    name = "presenters"
+    description = "Draws the conversation: messages, tool calls, results and the rest"
+
+    def activate(self, ctx: PluginContext) -> None:
+        """Register every built-in presenter at the priority its class declares."""
+        if ctx.tui is None:
+            return
+        for presenter in BUILTIN_PRESENTERS:
+            ctx.tui.register_presenter(presenter)