agent-readable 0.1.0__tar.gz

agent_readable-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,60 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build sdist + wheel
+        run: uv build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      # Required for PyPI Trusted Publishing (OIDC).
+      # Configure the trusted publisher on PyPI before the first tag push.
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: publish-pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

agent_readable-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install project + dev deps
+        run: uv sync --python ${{ matrix.python-version }} --group dev
+
+      - name: Run tests
+        run: uv run --python ${{ matrix.python-version }} pytest
+
+      - name: Smoke-test examples
+        run: |
+          for f in examples/*.py; do
+            echo "--- $f ---"
+            uv run --python ${{ matrix.python-version }} python "$f" > /dev/null
+          done

agent_readable-0.1.0/.gitignore

@@ -0,0 +1,45 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# Type checking
+.mypy_cache/
+.pytype/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Hatch
+hatch.toml
+
+# No external dependencies for this project, and uv.lock is only needed for local dev.
+uv.lock

agent_readable-0.1.0/AGENT-PROMPT.md

@@ -0,0 +1,76 @@
+# Coding Agent Instructions — agent-readable
+
+This repository uses `agent-readable`. Install if needed: `pip install agent-readable`
+
+## Before using or modifying a class or module
+
+Do not guess. Run this first:
+
+```python
+from agent_readable import agent_help
+
+print(agent_help(ClassName))
+# or: python -m agent_readable package.module:ClassName
+
+# or
+print(agent_help(package.module))
+# or: python -m agent_readable package.module
+```
+
+Treat the output as the canonical usage guide. Follow do/don't rules, anti-patterns, and lifecycle constraints exactly. Do not invent behavior that contradicts it.
+
+After modifying a class, prefer docstrings first — only update `__agent_notes__()` for corner cases docstrings cannot express. Verify `agent_help(ClassName)` is still accurate.
+
+## Making a class agent-readable
+
+**New class** — inherit `AgentReadableMixin`:
+
+```python
+from agent_readable import AgentReadableMixin
+
+
+class ResourcePool(AgentReadableMixin):
+    """
+    Rotates interchangeable resources such as API keys.
+
+    Agent usage:
+        Run ``agent_help(ResourcePool)`` before using this class in generated code.
+    """
+
+    def __init__(self, resources, *, cooldown: float = 60): ...
+
+    def call(self, fn):
+        """Call fn(resource) with automatic rotation and retry."""
+
+    @classmethod
+    def __agent_notes__(cls) -> str:
+        return """
+## Do
+
+- Use `call()` for normal non-streaming requests.
+
+## Do not
+
+- Do not use for streaming requests.
+"""
+```
+
+**Wrapping an existing class** — just mix in:
+
+```python
+class Connection(sqlite3.Connection, AgentReadableMixin):
+    """An agent-friendly wrapper around sqlite3.Connection."""
+```
+
+Guidelines:
+
+- Class docstring → "Purpose" section. Method docstrings → "Public API" summaries.
+- Override `__agent_notes__()` only for corner cases and anti-patterns. The mixin is not required for notes — Defining `__agent_notes__()` on any class (or monkey-patching it onto a third-party class) is enough; `agent_help()` collects it from the MRO automatically.
+- Add an "Agent usage" hint in the docstring — agents see it even via `help()`.
+- Simple data-only classes do not need agent docs.
+
+## Making a module agent-readable
+
+Modules are auto-documented — `agent_help()` generates docs from the module docstring and public members.
+
+**Do not override `__agent_help__` on a module unless absolutely necessary.** Unlike classes (which have `__agent_notes__()` to append guidance), overriding `__agent_help__` on a module replaces the auto-generated summary entirely — you lose signatures, purpose, and public API listing. Prefer writing clear docstrings on the module and its functions/classes instead.

agent_readable-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 zydo and agent-readable contributors
+
+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.