You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Document, in one place, exactly what the project supports and tests: Python
versions (tested 3.10–3.12 today; target 3.10–3.14 per #113), dependency ranges
(httpx, pydantic), extras and their version envelopes (mcp SDK, otel, yaml/toml,
tiktoken), OS coverage, and how long each is supported — with CI as the
enforcement reference.
Why this matters
Adoption decisions in teams hinge on compatibility confidence: "does this work with
our Python 3.12 + pydantic v2 pin + current mcp SDK?" Today the answer requires
reading pyproject.toml and CI YAML. A published matrix converts that research
into a glance, and the support-policy half ("we test X in CI; Y is best-effort")
sets honest expectations that prevent breakage surprises. This complements #113
(which widens the range) by communicating whatever the range is, and it gives
the stability docs (#145) their compatibility chapter.
Current evidence
.github/workflows/ci.yml: test matrix covers 3.10–3.12; pyproject.toml declares requires-python = ">=3.10" and extras with ranges (tiktoken>=0.6, etc.).
No support/compatibility documentation exists in README or docs/.
External context
Compatibility tables and explicit support windows (aligned to upstream Python EOL
schedules) are standard practice for widely adopted libraries.
Proposed implementation
Add a "Compatibility" section to README (or docs/compatibility.md linked from
README): table of Python versions (tested vs supported), core dep ranges,
extras matrix, platforms exercised in CI.
Summary
Document, in one place, exactly what the project supports and tests: Python
versions (tested 3.10–3.12 today; target 3.10–3.14 per #113), dependency ranges
(httpx, pydantic), extras and their version envelopes (mcp SDK, otel, yaml/toml,
tiktoken), OS coverage, and how long each is supported — with CI as the
enforcement reference.
Why this matters
Adoption decisions in teams hinge on compatibility confidence: "does this work with
our Python 3.12 + pydantic v2 pin + current mcp SDK?" Today the answer requires
reading
pyproject.tomland CI YAML. A published matrix converts that researchinto a glance, and the support-policy half ("we test X in CI; Y is best-effort")
sets honest expectations that prevent breakage surprises. This complements #113
(which widens the range) by communicating whatever the range is, and it gives
the stability docs (#145) their compatibility chapter.
Current evidence
.github/workflows/ci.yml: test matrix covers 3.10–3.12;pyproject.tomldeclaresrequires-python = ">=3.10"and extras with ranges (tiktoken>=0.6, etc.).docs/.External context
Compatibility tables and explicit support windows (aligned to upstream Python EOL
schedules) are standard practice for widely adopted libraries.
Proposed implementation
docs/compatibility.mdlinked fromREADME): table of Python versions (tested vs supported), core dep ranges,
extras matrix, platforms exercised in CI.
dropping versions (CHANGELOG + minor release), alignment with [Docs] Publish ROADMAP.md and an API stability / deprecation policy toward 1.0 #145's stability
policy when it lands.
matrix against
ci.yml's actual matrix (parse the workflow file).AI-agent execution notes
pyproject.toml(requires-python, deps, extras, classifiers),.github/workflows/ci.yml(matrix), open issue packaging: support Python 3.10–3.14 (inclusive) + library-grade dependency constraints (no forced version pins) #113 text.pyproject.tomlshould agree with the documented matrix — fix mismatches found.Acceptance criteria
Test plan
The drift guard; classifier consistency check; docs review. Run
make ci.Documentation plan
README/docs page as described; CHANGELOG
Added(docs).Migration and compatibility notes
Not expected to require migration.
Risks and tradeoffs
A published policy is a commitment — scope it to what CI already proves to keep the
cost honest. Maintenance is one row per Python release cycle.
Suggested labels
adoption, documentation, reliability