fixyourdocs 0.1.0__py3-none-any.whl

fixyourdocs/__init__.py

@@ -0,0 +1,56 @@
+"""Reference Python SDK for the Docs Feedback Protocol v0.
+
+See <https://github.com/fixyourdocs/protocol> for the wire-format spec.
+"""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+from fixyourdocs._results import SendResult
+from fixyourdocs.client import AsyncClient, Client
+from fixyourdocs.errors import (
+    AuthError,
+    FixYourDocsError,
+    NotFoundError,
+    OptedOutError,
+    PayloadTooLargeError,
+    PolicyRejectedError,
+    RateLimitedError,
+    ServerError,
+    UnsupportedMediaTypeError,
+    ValidationError,
+)
+from fixyourdocs.models import (
+    AgentInfo,
+    Evidence,
+    EvidenceKind,
+    Report,
+    ReportBody,
+    ReportKind,
+    TaskContext,
+)
+
+__all__ = [
+    "__version__",
+    "AgentInfo",
+    "AsyncClient",
+    "AuthError",
+    "Client",
+    "Evidence",
+    "EvidenceKind",
+    "FixYourDocsError",
+    "NotFoundError",
+    "OptedOutError",
+    "PayloadTooLargeError",
+    "PolicyRejectedError",
+    "RateLimitedError",
+    "Report",
+    "ReportBody",
+    "ReportKind",
+    "SendResult",
+    "ServerError",
+    "TaskContext",
+    "UnsupportedMediaTypeError",
+    "ValidationError",
+]

fixyourdocs/_http.py

@@ -0,0 +1,157 @@
+"""Shared HTTP helpers used by both ``Client`` and ``AsyncClient``."""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+import httpx
+
+from fixyourdocs._results import SendResult
+from fixyourdocs.errors import (
+    AuthError,
+    FixYourDocsError,
+    NotFoundError,
+    OptedOutError,
+    PayloadTooLargeError,
+    PolicyRejectedError,
+    RateLimitedError,
+    ServerError,
+    UnsupportedMediaTypeError,
+    ValidationError,
+)
+
+PROTOCOL_VERSION = "0"
+PROTOCOL_VERSION_HEADER = "X-Docs-Feedback-Protocol-Version"
+REPORTS_PATH = "/v1/reports"
+RETRYABLE_STATUS_CODES = frozenset({502, 503, 504})
+
+
+def _sdk_user_agent() -> str:
+    # Import here to avoid an import cycle (``__init__`` re-exports from
+    # ``client.py``, which imports this module).
+    from fixyourdocs import __version__
+
+    return f"fixyourdocs-python/{__version__}"
+
+
+def _build_headers(
+    token: Optional[str],
+    idempotency_key: Optional[str],
+) -> dict[str, str]:
+    """Assemble the request headers for ``POST /v1/reports``."""
+    headers: dict[str, str] = {
+        "Content-Type": "application/json",
+        PROTOCOL_VERSION_HEADER: PROTOCOL_VERSION,
+        "User-Agent": _sdk_user_agent(),
+        "Accept": "application/json",
+    }
+    if token:
+        headers["Authorization"] = f"Bearer {token}"
+    if idempotency_key:
+        headers["Idempotency-Key"] = idempotency_key
+    return headers
+
+
+def _safe_json(response: httpx.Response) -> dict[str, Any]:
+    """Decode a response body as JSON, returning ``{}`` on failure."""
+    try:
+        data = response.json()
+    except Exception:
+        return {}
+    if isinstance(data, dict):
+        return data
+    return {}
+
+
+def _retry_after_seconds(response: httpx.Response) -> Optional[int]:
+    raw = response.headers.get("Retry-After")
+    if raw is None:
+        return None
+    try:
+        return int(raw.strip())
+    except ValueError:
+        return None
+
+
+def is_retryable_status(status_code: int) -> bool:
+    """Return ``True`` if the SDK should retry once on this status."""
+    return status_code in RETRYABLE_STATUS_CODES
+
+
+def _raise_for_status(response: httpx.Response) -> None:
+    """Translate a non-2xx response into the matching typed error."""
+    status = response.status_code
+    body = _safe_json(response)
+    error_message = str(body.get("error") or response.reason_phrase or f"HTTP {status}")
+
+    if status == 400:
+        raise ValidationError(
+            error_message,
+            status_code=status,
+            body=body,
+            details=list(body.get("details") or []),
+        )
+    if status == 401:
+        raise AuthError(error_message, status_code=status, body=body)
+    if status == 404:
+        raise NotFoundError(error_message, status_code=status, body=body)
+    if status == 410:
+        raise OptedOutError(
+            error_message,
+            status_code=status,
+            body=body,
+            since=body.get("since"),
+        )
+    if status == 413:
+        raw_max = body.get("max_bytes")
+        max_bytes: Optional[int]
+        try:
+            max_bytes = int(raw_max) if raw_max is not None else None
+        except (TypeError, ValueError):
+            max_bytes = None
+        raise PayloadTooLargeError(
+            error_message,
+            status_code=status,
+            body=body,
+            max_bytes=max_bytes,
+        )
+    if status == 415:
+        raise UnsupportedMediaTypeError(error_message, status_code=status, body=body)
+    if status == 422:
+        raise PolicyRejectedError(
+            error_message,
+            status_code=status,
+            body=body,
+            reason=body.get("reason"),
+        )
+    if status == 429:
+        raise RateLimitedError(
+            error_message,
+            status_code=status,
+            body=body,
+            retry_after=_retry_after_seconds(response),
+        )
+    if 500 <= status < 600:
+        raise ServerError(error_message, status_code=status, body=body)
+
+    # Any other 4xx the spec doesn't enumerate.
+    raise FixYourDocsError(error_message, status_code=status, body=body)
+
+
+def parse_response(response: httpx.Response) -> SendResult:
+    """Map a 2xx response to :class:`SendResult`; raise on non-2xx."""
+    if response.status_code in (200, 201):
+        body = _safe_json(response)
+        return SendResult(
+            id=str(body.get("id", "")),
+            received_at=body.get("received_at"),  # type: ignore[arg-type]
+            protocol_version=str(body.get("protocol_version", PROTOCOL_VERSION)),
+            server_capabilities=list(body.get("server_capabilities") or []),
+            is_duplicate=(response.status_code == 200),
+            status_code=response.status_code,
+        )
+    _raise_for_status(response)
+    # Unreachable, but keeps mypy happy.
+    raise FixYourDocsError(  # pragma: no cover
+        f"Unexpected status {response.status_code}", status_code=response.status_code
+    )

fixyourdocs/_results.py

@@ -0,0 +1,26 @@
+"""Result type returned by ``Client.send`` / ``AsyncClient.send``."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class SendResult(BaseModel):
+    """Server acknowledgement parsed from a ``200``/``201`` response.
+
+    ``is_duplicate`` is derived from the HTTP status code: ``201`` means
+    the server accepted a new submission, ``200`` means the idempotency
+    key matched an existing one.
+    """
+
+    model_config = ConfigDict(extra="ignore")
+
+    id: str
+    received_at: datetime
+    protocol_version: str
+    server_capabilities: list[str] = Field(default_factory=list)
+    is_duplicate: bool = False
+    status_code: Optional[int] = None

fixyourdocs/client.py

@@ -0,0 +1,126 @@
+"""Sync and async HTTP clients for the Docs Feedback Protocol v0."""
+
+from __future__ import annotations
+
+from types import TracebackType
+from typing import Any, Optional, Union
+
+import httpx
+
+from fixyourdocs._http import (
+    REPORTS_PATH,
+    _build_headers,
+    is_retryable_status,
+    parse_response,
+)
+from fixyourdocs._results import SendResult
+from fixyourdocs.models import Report
+
+
+def _serialize(report: Report) -> dict[str, Any]:
+    """Pydantic-dump a report into the wire-format JSON object."""
+    return report.model_dump(mode="json", exclude_none=True, by_alias=True)
+
+
+def _reports_url(api_url: str) -> str:
+    return f"{api_url.rstrip('/')}{REPORTS_PATH}"
+
+
+class Client:
+    """Synchronous client for ``POST /v1/reports``."""
+
+    def __init__(
+        self,
+        api_url: str,
+        *,
+        token: Optional[str] = None,
+        timeout: float = 10.0,
+        transport: Optional[httpx.BaseTransport] = None,
+    ) -> None:
+        self._api_url = api_url
+        self._token = token
+        self._timeout = timeout
+        self._http = httpx.Client(timeout=timeout, transport=transport)
+
+    def __enter__(self) -> Client:
+        return self
+
+    def __exit__(
+        self,
+        exc_type: Optional[type[BaseException]],
+        exc: Optional[BaseException],
+        tb: Optional[TracebackType],
+    ) -> None:
+        self.close()
+
+    def close(self) -> None:
+        self._http.close()
+
+    def send(
+        self,
+        report: Report,
+        *,
+        idempotency_key: Optional[str] = None,
+    ) -> SendResult:
+        """Submit ``report``. Returns :class:`SendResult` on 200/201; raises on errors."""
+        url = _reports_url(self._api_url)
+        body = _serialize(report)
+        headers = _build_headers(self._token, idempotency_key)
+
+        response = self._http.post(url, json=body, headers=headers)
+        if is_retryable_status(response.status_code):
+            response = self._http.post(url, json=body, headers=headers)
+        return parse_response(response)
+
+
+class AsyncClient:
+    """Asynchronous client for ``POST /v1/reports``."""
+
+    def __init__(
+        self,
+        api_url: str,
+        *,
+        token: Optional[str] = None,
+        timeout: float = 10.0,
+        transport: Optional[Union[httpx.AsyncBaseTransport, httpx.BaseTransport]] = None,
+    ) -> None:
+        self._api_url = api_url
+        self._token = token
+        self._timeout = timeout
+        # ``httpx.MockTransport`` satisfies both sync and async transport
+        # protocols, which makes it convenient for tests; we just accept
+        # either here and pass it through.
+        self._http = httpx.AsyncClient(
+            timeout=timeout,
+            transport=transport,  # type: ignore[arg-type]
+        )
+
+    async def __aenter__(self) -> AsyncClient:
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: Optional[type[BaseException]],
+        exc: Optional[BaseException],
+        tb: Optional[TracebackType],
+    ) -> None:
+        await self.aclose()
+
+    async def aclose(self) -> None:
+        await self._http.aclose()
+
+    async def send(
+        self,
+        report: Report,
+        *,
+        idempotency_key: Optional[str] = None,
+    ) -> SendResult:
+        """Submit ``report``. Returns :class:`SendResult` on 200/201; raises on errors."""
+        url = _reports_url(self._api_url)
+        body = _serialize(report)
+        headers = _build_headers(self._token, idempotency_key)
+
+        response = await self._http.post(url, json=body, headers=headers)
+        if is_retryable_status(response.status_code):
+            response = await self._http.post(url, json=body, headers=headers)
+        return parse_response(response)

fixyourdocs/errors.py

@@ -0,0 +1,123 @@
+"""Typed exceptions raised by the SDK on non-2xx HTTP responses.
+
+These mirror the error table in §7.3 of the protocol spec. Each
+exception captures whatever extra context the wire format carries for
+its status code (e.g. ``retry_after`` for 429, ``since`` for 410), so
+callers can branch on the type and read the structured fields instead
+of re-parsing the response body.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+
+class FixYourDocsError(Exception):
+    """Base class for every typed SDK error.
+
+    All concrete subclasses carry the raw decoded JSON body (when one
+    was returned) on ``.body`` so callers can inspect server-specific
+    extensions that v0 does not standardise.
+    """
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: Optional[int] = None,
+        body: Optional[dict[str, Any]] = None,
+    ) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+        self.body = body or {}
+
+
+class ValidationError(FixYourDocsError):
+    """``400`` — body failed schema validation or version header mismatch."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: Optional[int] = None,
+        body: Optional[dict[str, Any]] = None,
+        details: Optional[list[dict[str, Any]]] = None,
+    ) -> None:
+        super().__init__(message, status_code=status_code, body=body)
+        self.details: list[dict[str, Any]] = details or []
+
+
+class AuthError(FixYourDocsError):
+    """``401`` — auth required and missing/invalid."""
+
+
+class NotFoundError(FixYourDocsError):
+    """``404`` — endpoint does not map to a known receiving organisation."""
+
+
+class OptedOutError(FixYourDocsError):
+    """``410`` — the receiving organisation has opted out."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: Optional[int] = None,
+        body: Optional[dict[str, Any]] = None,
+        since: Optional[str] = None,
+    ) -> None:
+        super().__init__(message, status_code=status_code, body=body)
+        self.since = since
+
+
+class PayloadTooLargeError(FixYourDocsError):
+    """``413`` — body exceeds the server's size limit."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: Optional[int] = None,
+        body: Optional[dict[str, Any]] = None,
+        max_bytes: Optional[int] = None,
+    ) -> None:
+        super().__init__(message, status_code=status_code, body=body)
+        self.max_bytes = max_bytes
+
+
+class UnsupportedMediaTypeError(FixYourDocsError):
+    """``415`` — Content-Type was not JSON."""
+
+
+class PolicyRejectedError(FixYourDocsError):
+    """``422`` — body validated but server rejected on policy grounds."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: Optional[int] = None,
+        body: Optional[dict[str, Any]] = None,
+        reason: Optional[str] = None,
+    ) -> None:
+        super().__init__(message, status_code=status_code, body=body)
+        self.reason = reason
+
+
+class RateLimitedError(FixYourDocsError):
+    """``429`` — rate-limited; ``retry_after`` from the ``Retry-After`` header."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: Optional[int] = None,
+        body: Optional[dict[str, Any]] = None,
+        retry_after: Optional[int] = None,
+    ) -> None:
+        super().__init__(message, status_code=status_code, body=body)
+        self.retry_after = retry_after
+
+
+class ServerError(FixYourDocsError):
+    """``5xx`` — server-side failure (after the one allowed retry)."""

fixyourdocs/models.py

@@ -0,0 +1,178 @@
+"""Pydantic v2 models mirroring ``schema/v0/report.schema.json``.
+
+The models are deliberately a 1:1 translation of the JSON Schema so
+serialised output round-trips byte-for-byte against the canonical
+example fixtures. ``Report.create(...)`` is the ergonomic, flat
+constructor most callers should reach for; the nested
+``Report(agent=..., report=...)`` form is exposed for advanced use.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+from enum import Enum
+from typing import Any, Literal, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class EvidenceKind(str, Enum):
+    """Enumerated kinds of evidence; see §4.4 of the spec."""
+
+    ERROR_MESSAGE = "error_message"
+    ATTEMPTED_ACTION = "attempted_action"
+    EXPECTED = "expected"
+    OBSERVED = "observed"
+    CODE_SNIPPET = "code_snippet"
+    QUOTE = "quote"
+
+
+class ReportKind(str, Enum):
+    """Enumerated kinds of report; see §4.4 of the spec."""
+
+    BROKEN = "broken"
+    INCORRECT = "incorrect"
+    OUTDATED = "outdated"
+    MISSING = "missing"
+    UNCLEAR = "unclear"
+    OTHER = "other"
+
+
+class Evidence(BaseModel):
+    """One evidence item attached to a report body."""
+
+    model_config = ConfigDict(extra="forbid", use_enum_values=True)
+
+    kind: EvidenceKind
+    text: str = Field(..., min_length=1, max_length=4000)
+
+
+class AgentInfo(BaseModel):
+    """Identification of the agent that produced the report."""
+
+    model_config = ConfigDict(extra="forbid")
+
+    name: str = Field(
+        ...,
+        min_length=1,
+        max_length=64,
+        pattern=r"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$",
+    )
+    version: Optional[str] = Field(default=None, max_length=64)
+    vendor: Optional[str] = Field(default=None, max_length=128)
+
+
+class ReportBody(BaseModel):
+    """The substance of the feedback."""
+
+    model_config = ConfigDict(extra="forbid", use_enum_values=True)
+
+    kind: ReportKind
+    summary: str = Field(..., min_length=1, max_length=500)
+    details: Optional[str] = Field(default=None, max_length=8000)
+    evidence: Optional[list[Evidence]] = Field(default=None, max_length=20)
+    suggested_fix: Optional[str] = Field(default=None, max_length=4000)
+
+
+class TaskContext(BaseModel):
+    """Optional context about the agent task that surfaced the issue."""
+
+    model_config = ConfigDict(extra="forbid")
+
+    task_summary: Optional[str] = Field(default=None, max_length=500)
+    transcript_excerpt: Optional[str] = Field(default=None, max_length=4000)
+
+
+class Report(BaseModel):
+    """A single Docs Feedback Protocol v0 report.
+
+    Use :meth:`Report.create` for the ergonomic flat constructor. The
+    nested form (passing :class:`AgentInfo` / :class:`ReportBody`
+    explicitly) is also supported.
+    """
+
+    model_config = ConfigDict(extra="forbid", populate_by_name=True)
+
+    protocol_version: Literal["0"] = "0"
+    doc_url: str = Field(..., max_length=2048)
+    agent: AgentInfo
+    report: ReportBody
+    task_context: Optional[TaskContext] = None
+    idempotency_key: Optional[str] = Field(
+        default=None,
+        min_length=1,
+        max_length=128,
+        pattern=r"^[\x21-\x7e]+$",
+    )
+    submitted_at: Optional[datetime] = None
+    locale: Optional[str] = Field(
+        default=None,
+        max_length=35,
+        pattern=r"^[A-Za-z]{1,8}(-[A-Za-z0-9]{1,8})*$",
+    )
+    client_capabilities: Optional[list[str]] = Field(default=None, max_length=32)
+
+    @classmethod
+    def create(
+        cls,
+        *,
+        doc_url: str,
+        summary: str,
+        kind: ReportKind | str,
+        agent_name: str,
+        agent_version: Optional[str] = None,
+        agent_vendor: Optional[str] = None,
+        details: Optional[str] = None,
+        evidence: Optional[list[Evidence | dict[str, Any]]] = None,
+        suggested_fix: Optional[str] = None,
+        task_summary: Optional[str] = None,
+        transcript_excerpt: Optional[str] = None,
+        idempotency_key: Optional[str] = None,
+        submitted_at: Optional[datetime] = None,
+        locale: Optional[str] = None,
+        client_capabilities: Optional[list[str]] = None,
+    ) -> Report:
+        """Build a :class:`Report` from a flat keyword-argument set.
+
+        This is the convenience constructor for the common case of
+        producing a one-shot report without manually instantiating the
+        nested ``AgentInfo``, ``ReportBody``, and ``TaskContext``
+        objects.
+        """
+        agent = AgentInfo(name=agent_name, version=agent_version, vendor=agent_vendor)
+
+        ev_models: Optional[list[Evidence]]
+        if evidence is None:
+            ev_models = None
+        else:
+            ev_models = [
+                item if isinstance(item, Evidence) else Evidence(**item) for item in evidence
+            ]
+
+        body = ReportBody(
+            kind=ReportKind(kind) if not isinstance(kind, ReportKind) else kind,
+            summary=summary,
+            details=details,
+            evidence=ev_models,
+            suggested_fix=suggested_fix,
+        )
+
+        task_context: Optional[TaskContext]
+        if task_summary is None and transcript_excerpt is None:
+            task_context = None
+        else:
+            task_context = TaskContext(
+                task_summary=task_summary,
+                transcript_excerpt=transcript_excerpt,
+            )
+
+        return cls(
+            doc_url=doc_url,
+            agent=agent,
+            report=body,
+            task_context=task_context,
+            idempotency_key=idempotency_key,
+            submitted_at=submitted_at,
+            locale=locale,
+            client_capabilities=client_capabilities,
+        )

fixyourdocs-0.1.0.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: fixyourdocs
+Version: 0.1.0
+Summary: Reference Python SDK for the Docs Feedback Protocol
+Project-URL: Homepage, https://docsfeedback.org
+Project-URL: Repository, https://github.com/fixyourdocs/sdk-python
+Project-URL: Specification, https://github.com/fixyourdocs/protocol
+Author-email: FixYourDocs <hello@fixyourdocs.org>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,ai,docs,documentation,feedback,protocol
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+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: Topic :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.6
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# fixyourdocs (Python SDK)
+
+Reference Python SDK for the [Docs Feedback Protocol](https://github.com/fixyourdocs/protocol)
+v0. The protocol lets AI agents file structured reports against
+documentation pages when the docs break agent task flows.
+
+- Spec: <https://docsfeedback.org>.
+- Why this exists: [the FixYourDocs manifesto](https://github.com/fixyourdocs/manifesto/blob/main/MANIFESTO.md).
+
+## Install
+
+```sh
+pip install fixyourdocs
+```
+
+Requires Python 3.9+.
+
+## Usage (sync)
+
+```python
+from fixyourdocs import Client, Report
+
+report = Report.create(
+    doc_url="https://docs.example.com/getting-started",
+    summary="The page does not document how to set the API_KEY env var.",
+    kind="missing",
+    agent_name="claude-code",
+)
+
+with Client(api_url="https://hub.fixyourdocs.io") as client:
+    result = client.send(report)
+
+print(result.id, result.is_duplicate)
+```
+
+## Usage (async)
+
+```python
+import asyncio
+from fixyourdocs import AsyncClient, Report
+
+async def main() -> None:
+    report = Report.create(
+        doc_url="https://docs.example.com/getting-started",
+        summary="The page does not document how to set the API_KEY env var.",
+        kind="missing",
+        agent_name="claude-code",
+    )
+    async with AsyncClient(api_url="https://hub.fixyourdocs.io") as client:
+        result = await client.send(report)
+    print(result.id, result.is_duplicate)
+
+asyncio.run(main())
+```
+
+## API shape
+
+The wire format is a nested object (`agent`, `report`, `task_context`),
+so the SDK exposes two ways to build a `Report`:
+
+- **`Report.create(...)`** — ergonomic, flat keyword-argument
+  constructor for the common case. Internally builds the nested
+  wire-format structure.
+- **`Report(agent=AgentInfo(...), report=ReportBody(...), ...)`** — the
+  typed nested form, useful when constructing reports programmatically
+  from already-typed sub-objects.
+
+Both produce identical wire output.
+
+## Errors
+
+Non-2xx responses raise typed exceptions:
+
+| Status | Exception |
+|---|---|
+| 400 | `ValidationError` (`.details`) |
+| 401 | `AuthError` |
+| 404 | `NotFoundError` |
+| 410 | `OptedOutError` (`.since`) |
+| 413 | `PayloadTooLargeError` (`.max_bytes`) |
+| 415 | `UnsupportedMediaTypeError` |
+| 422 | `PolicyRejectedError` (`.reason`) |
+| 429 | `RateLimitedError` (`.retry_after`) |
+| 5xx | `ServerError` (after one automatic retry on 502/503/504) |
+
+All inherit from `FixYourDocsError`.
+
+## Licence
+
+Apache License 2.0 — see [LICENSE](LICENSE).
+
+## Contributing
+
+Contributions require a DCO sign-off and a signed Apache Individual
+Contributor License Agreement — see [CONTRIBUTING.md](CONTRIBUTING.md).

fixyourdocs-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+fixyourdocs/__init__.py,sha256=4ZHLSmlpOEnk_6y8rZYYEz0kYIsoSYFBNy3YVrrr5es,1130
+fixyourdocs/_http.py,sha256=ERBhMuUP-5MF18NjpNeZFvLCkxG0eF9B-ZTKXv0kDqg,4914
+fixyourdocs/_results.py,sha256=fz7HKAqb2j1y0id3hZac2w3vX6sgXMp29epySpnWvMo,750
+fixyourdocs/client.py,sha256=6DYcTGjgaJ4oAxUmIKnIKyYwZzSWa6YzRLhzM1H7uKU,3719
+fixyourdocs/errors.py,sha256=2s7A_NJ7XRiJj0Iyt-nDHVHaYC7Y5cLeNjSM8f_6-hY,3624
+fixyourdocs/models.py,sha256=9tD3UURwv6N111f0ev3thW6anKuK4VZgiQyDJCzpC9k,5613
+fixyourdocs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fixyourdocs-0.1.0.dist-info/METADATA,sha256=NZl1Aqhub4Lc6vDftHCwfDvjxxLljBnTCE-5ab_K-4M,4007
+fixyourdocs-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+fixyourdocs-0.1.0.dist-info/licenses/LICENSE,sha256=sD0F9MsULLCVKAXoaS8HbMkKPUtV5lh2_wEjYozVPoU,11357
+fixyourdocs-0.1.0.dist-info/RECORD,,

fixyourdocs-0.1.0.dist-info/WHEEL

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

fixyourdocs-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 FixYourDocs (Maciej Stopa)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.