zettcode-instructions 0.4.1__tar.gz

zettcode_instructions-0.4.1/.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_instructions-0.4.1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.5
+Name: zettcode-instructions
+Version: 0.4.1
+Summary: The workspace's AGENTS.md instructions of ZettCode, as a part of the agent that lives apart from it
+Project-URL: Repository, https://github.com/Chang-LeHung/zettcode
+Author: Chang-LeHung
+License-Expression: MIT
+Keywords: agent,agents-md,instructions,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: zett-agent<0.3,>=0.2.7
+Requires-Dist: zettcode-engine

zettcode_instructions-0.4.1/pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "zettcode-instructions"
+description = "The workspace's AGENTS.md instructions of ZettCode, as a part of the agent that lives apart from it"
+requires-python = ">=3.10"
+dynamic = ["version"]
+license = "MIT"
+authors = [{name = "Chang-LeHung"}]
+keywords = ["zettcode", "agents-md", "instructions", "agent"]
+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 = [
+  # The plugin base classes and the switch the runtime provides.
+  "zettcode-engine",
+  # The extension the factory builds.
+  "zett-agent>=0.2.7,<0.3",
+]
+
+# A part of the program, not a plugin: the `[tool.zettcode] plugin = true` marker is what the plugin release line looks for. It is
+# activated with the agent's other parts and `[agents_md] enabled` is what turns it off.
+[project.entry-points."zettcode.plugin"]
+project-instructions = "zettcode.instructions.plugin:ProjectInstructions"
+
+[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_instructions-0.4.1/src/zettcode/instructions/__init__.py

@@ -0,0 +1,12 @@
+"""The workspace's ``AGENTS.md`` instructions of ZettCode: the plugin that hands them to the agent.
+
+A part of the program that lives in a distribution of its own, found through the ``zettcode.plugin`` entry point.
+``[agents_md] enabled`` in the configuration is what turns it off. The extension is imported by the factory, so a launch
+that never builds an agent does not pay for it.
+"""
+
+from __future__ import annotations
+
+from .plugin import ProjectInstructions
+
+__all__ = ["ProjectInstructions"]

zettcode_instructions-0.4.1/src/zettcode/instructions/plugin.py

@@ -0,0 +1,34 @@
+"""The plugin that hands the agent the workspace's project instructions."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from zettcode.engine.plugins.context import PluginContext
+from zettcode.engine.plugins.plugin import Plugin, PluginSetting
+
+if TYPE_CHECKING:  # pragma: no cover - annotations only
+    from zett_agent.extensions.base import AgentExtension
+
+    from zettcode.engine.plugins.state import AgentBuild
+
+
+class ProjectInstructions(Plugin[PluginContext]):
+    """The workspace's ``AGENTS.md`` files, read again for every request so an edit applies at once."""
+
+    name = "project-instructions"
+    description = "The workspace's AGENTS.md instructions"
+    setting = PluginSetting("agents_md_enabled", "agents_md")
+
+    def activate(self, ctx: PluginContext) -> None:
+        """Hand the agent the instructions, unless the configuration turned them off."""
+        config = ctx.config
+        if not config.agents_md_enabled:
+            return
+
+        def build(_: AgentBuild) -> AgentExtension:
+            from zett_agent.extensions.agents_md import AgentsMdExtension
+
+            return AgentsMdExtension(config.workspace)
+
+        ctx.agent.register_extension_factory("AgentsMdExtension", build)