zettcode-models 0.1.0__py3-none-any.whl

zettcode/models/__init__.py

@@ -0,0 +1,156 @@
+"""Official models for the vendor API keys found in the environment.
+
+A reader who has ``OPENAI_API_KEY``, ``ANTHROPIC_API_KEY``, ``DEEPSEEK_API_KEY`` or ``ZAI_API_KEY`` set does not
+have to type an address or a model id to try that vendor. The plugin knows the current official model of each host,
+registers it as one :class:`~zettcode.plugin_api.ProvidedModel`, and leaves the token to the runtime, which reads it
+from the variable named here and never writes it to the configuration.
+
+The list is deliberately static: a start asks no vendor for anything, so a key in the environment costs no network
+round trip. It is off by default — ambient keys should not change a model list unless the reader enables the plugin
+with ``[plugins] enable = ["models"]``.
+"""
+
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+
+from zettcode.plugin_api import Plugin, PluginContext, ProvidedModel, Provider
+
+#: The one place the version is written; ``pyproject.toml`` reads it from here.
+__version__ = "0.1.0"
+
+
+@dataclass(frozen=True, slots=True)
+class Vendor:
+    """One host an environment variable can open.
+
+    Attributes:
+        name: The provider name, which is unique across the application.
+        label: What a list shows for the host.
+        env: The variables that may hold the key, most specific first.
+        base_url: The address the client appends its route to.
+        api: Which protocol the host speaks.
+        model: The vendor's current official model id.
+        display: What ``/model`` shows for it.
+        context_window: Tokens it can carry.
+        multimodal: Whether it takes images.
+    """
+
+    name: str
+    label: str
+    env: tuple[str, ...]
+    base_url: str
+    api: str
+    model: str
+    display: str
+    context_window: int
+    multimodal: bool = False
+
+    def key(self) -> tuple[str, str] | None:
+        """Return the variable that holds this host's key and the key itself, or ``None`` when none is set."""
+        for variable in self.env:
+            value = os.getenv(variable)
+            if value:
+                return variable, value
+        return None
+
+
+#: The official model offered for each host, checked against the vendors' model pages on 2026-11-10. The ids and
+#: windows are the whole of this plugin's knowledge: when a vendor moves on, this table is the one place to edit.
+VENDORS: tuple[Vendor, ...] = (
+    Vendor(
+        "openai",
+        "OpenAI",
+        ("OPENAI_API_KEY",),
+        "https://api.openai.com/v1",
+        "chat",
+        "gpt-6.1-sol",
+        "GPT-6.1 Sol",
+        1_050_000,
+        multimodal=True,
+    ),
+    Vendor(
+        "anthropic",
+        "Anthropic",
+        ("ANTHROPIC_API_KEY",),
+        "https://api.anthropic.com",
+        "anthropic",
+        "claude-opus-5-5",
+        "Claude Opus 5.5",
+        1_000_000,
+        multimodal=True,
+    ),
+    Vendor(
+        "deepseek",
+        "DeepSeek",
+        ("DEEPSEEK_API_KEY",),
+        "https://api.deepseek.com",
+        "chat",
+        "deepseek-v4.1-flash",
+        "DeepSeek V4.1 Flash",
+        1_000_000,
+    ),
+    Vendor(
+        "zai",
+        "Z.AI",
+        ("ZAI_API_KEY", "ZHIPUAI_API_KEY", "ZHIPU_API_KEY"),
+        "https://api.z.ai/api/paas/v4",
+        "chat",
+        "glm-5.3",
+        "GLM-5.3",
+        1_000_000,
+    ),
+)
+
+
+def _provider(vendor: Vendor, variable: str) -> Provider:
+    """Return the host description for one vendor, with the one model it offers."""
+    return Provider(
+        vendor.name,
+        vendor.label,
+        # The vendor names the protocol as the word Provider parses.
+        api=vendor.api,  # type: ignore[arg-type]
+        base_url=vendor.base_url,
+        token_env=variable,
+        models=(
+            ProvidedModel(
+                vendor.model,
+                display_model=vendor.display,
+                context_window=vendor.context_window,
+                multimodal=vendor.multimodal,
+            ),
+        ),
+        note="official model",
+    )
+
+
+class ModelsPlugin(Plugin[PluginContext]):
+    """Offer one official model for each vendor whose API key is in the environment."""
+
+    name = "models"
+    description = "An official model for each vendor API key in the environment"
+
+    @classmethod
+    def default_enabled(cls) -> bool:
+        """Stay off until the reader asks for it: ambient keys should not change a model list by themselves."""
+        return False
+
+    def activate(self, ctx: PluginContext) -> None:
+        """Register the host of every key that is set, with its current official model."""
+        clashes: list[str] = []
+        for vendor in VENDORS:
+            key = vendor.key()
+            if key is None:
+                continue
+            try:
+                ctx.agent.register_provider(_provider(vendor, key[0]))
+            except ValueError as error:
+                # A clash is not swallowed: the loader reports this plugin failed, so the reader sees why the host
+                # is absent instead of finding it missing with no word. Every clash is named, not only the first.
+                clashes.append(f"{vendor.label}: {error}")
+        if clashes:
+            raise ValueError("; ".join(clashes))
+
+
+__all__ = ["ModelsPlugin", "Vendor", "VENDORS", "__version__"]

zettcode_models-0.1.0.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.5
+Name: zettcode-models
+Version: 0.1.0
+Summary: A ZettCode plugin: an official model for each vendor API key found in the environment
+Project-URL: Repository, https://github.com/Chang-LeHung/zettcode/tree/main/packages/zettcode-models
+Project-URL: Issues, https://github.com/Chang-LeHung/zettcode/issues
+Author: Chang-LeHung
+License-Expression: MIT
+License-File: LICENSE
+Keywords: environment,models,plugin,providers,zettcode
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+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: Topic :: Software Development :: User Interfaces
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: zettcode-plugin-api<0.5,>=0.4
+Description-Content-Type: text/markdown
+
+# zettcode-models
+
+A ZettCode plugin that offers an **official model** for each vendor whose API key is in the environment:
+OpenAI, Anthropic, DeepSeek and Z.AI.
+
+Install it as an extra and enable it once:
+
+```bash
+pip install "zettcode[models]"
+```
+
+```toml
+[plugins]
+enable = ["models"]
+```
+
+With `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, `DEEPSEEK_API_KEY` or `ZAI_API_KEY` set (`ZHIPUAI_API_KEY` and
+`ZHIPU_API_KEY` are accepted aliases), the plugin registers that host with its current official model — `GPT-6.1 Sol`,
+`Claude Opus 5.5`, `DeepSeek V4.1 Flash` or `GLM-5.3`. The model appears in `/model` with `from the openai plugin`
+(or `anthropic`, `deepseek`, `zai`); its token is read from the environment and never written to `config.toml`.
+
+The list is static and no endpoint is called at start. The plugin is off by default: a set of ambient keys should not
+change a model list unless the reader asks it to.

zettcode_models-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+zettcode/models/__init__.py,sha256=jO7dLq4hH8Kqy5afgCJmQ0X_NbTz4Jkskk-vib-twHY,5253
+zettcode_models-0.1.0.dist-info/METADATA,sha256=1nO4ydAjoGcLflMRfhncjKYbrzGyxG81yqfGqiNFjFM,1947
+zettcode_models-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+zettcode_models-0.1.0.dist-info/entry_points.txt,sha256=U_LqiM9dSvmrn4ICnj6bVbnuYjPsW8kb-YX96JMemY4,56
+zettcode_models-0.1.0.dist-info/licenses/LICENSE,sha256=O9b87-u8V1aSp6xkr9qnbHZIJAWNV6m04GEQjycLLiw,1069
+zettcode_models-0.1.0.dist-info/RECORD,,

zettcode_models-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

zettcode_models-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[zettcode.plugin]
+models = zettcode.models:ModelsPlugin

zettcode_models-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Chang-LeHung
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.