Skip to content

Add a client libraries page (1.13.83) - #23

Merged
bensynapse merged 2 commits into
mainfrom
docs/client-libraries
Nov 12, 2026
Merged

bensynapse merged 2 commits into
mainfrom
docs/client-libraries

Conversation

@bensynapse

Copy link
Copy Markdown
Member

Adds docs/client-libraries.html, a page that lists every official client library with its version, minimum runtime and coverage. Spec version 1.13.83, with a changelog entry. Nothing on the wire changed.

What is on the page

  • A table of 15 packages. Eight are the language clients: Python, JavaScript and TypeScript, Go, PHP, .NET, Dart, R and Swift. Seven build on them: the MCP server, the Vercel AI SDK tools, the export command and the Laravel package. The other three are the Haystack, LangChain and LlamaIndex integrations.
  • Each row has the latest published version, the minimum runtime, the install command, the registry link, the language, the licence and the repository.
  • A second table says which packages cover REST, the live stream, file export and MCP.
  • A third table shows which endpoint groups each language client has a method for.
  • The smallest working call in each of the eight languages.

The page is a guide in GUIDES, built like export-formats.html. It adds no new component and no CSS. Some cells carry an inline white-space or overflow-wrap so a package name is not split mid-word. The first cell of each row is a row header, styled inline to look like a data cell.

Plugins for apps and automation platforms are left out. The page points to the GitHub organisation for those.

Where the facts come from

Fact Source, read on 2026-11-12
Version, minimum runtime, licence PyPI JSON API, npm registry, Go module proxy, Packagist, NuGet, pub.dev, R-universe
Swift version the newest Git tag, because the Swift client has no registry
Live stream column and the endpoint table the source of each published version, taken from its release tag or its npm tarball
Quick-start code the README of that published version, copied unchanged
Install commands the same README, or the registry's own install line for Dart and R

Three registries are behind their repositories. The page shows what is published: .NET 1.2.1, Dart 1.2.1 and Haystack 0.2.0.

New checks

  • _clients_drift stops the build when the endpoint table names an operation the spec does not define. It also stops the build when a row changes in a way the prose no longer matches.
  • scripts/check_client_versions.py reads every registry again. It compares the version, the minimum runtime and the licence with the table. It exits 1 when a row is behind and 2 when a registry could not be read. It needs the network, so no workflow runs it. No workflow changed.

Checks run

  • python3 scripts/build_reference.py --check: generated docs are current
  • sh scripts/truthcheck.sh: truthcheck OK
  • the contract script from lint.yml: OK, 48 paths, 49 operations, 66 schemas
  • python3 scripts/check_client_versions.py: 15 of 15 rows match their registry
  • the check script against mocked registry answers: a pre-release listed first, a wrong JSON shape, a dropped connection and a newer version. Each gives the right result and exit status.
  • the eight quick-start blocks are byte-identical to the README blocks they were copied from
  • every link on the page answers 200, apart from three npmjs.com package pages that answer 403 to a script. The npm registry API answers 200 for the same three packages.
  • at 360 px and at 1280 px the page has no horizontal overflow, and each table scrolls inside its own region

The page copy, the changelog entry, the commit message and this text were linted with hw_lint.py.

After merge

The page goes live at https://docs.livetennisapi.com/client-libraries.html when the docs are next published from main. PRs #15 and #16 also change scripts/build_reference.py, and #15 changes docs/index.html. Whichever merges later needs a rebase and a rebuild of the generated pages. This PR takes spec version 1.13.83.

client-libraries.html lists the eight official language clients and
seven packages built on them. It is a guide in the GUIDES list.

The first table has the install command, the registry, the latest
published version, the minimum runtime, the licence and the repository
of each package. The second says which of them cover REST, the live
stream, file export and MCP. The third shows which endpoint groups each
language client reaches.

Versions, runtimes and licences were read from PyPI, npm, the Go module
proxy, Packagist, NuGet, pub.dev and R-universe on 2026-11-12. The
Swift client has no registry, so its version is the newest Git tag.
Coverage was read from the source of each published version. Each quick
start is the README block of that version, unchanged.

scripts/check_client_versions.py reads the registries again and exits 1
when a row is behind. It needs the network, so no workflow runs it.

_clients_drift fails the build when the endpoint table names an
operation the spec does not define.

The docs menu, the docs home, the sitemap, llms.txt and the README link
the page. llms.txt also lists the six language clients it did not have.
Nothing on the wire changed.
The first cell of each row on the client libraries page is now a row
header. A screen reader then names the library next to each value.
Inline declarations keep it looking like a data cell.

The Python quick start note says the spec lets score be null. The
README example reads score.sets without a check.

check_client_versions.py always compares an SPDX licence expression,
however long it is. Only the older free-text field is skipped when it
holds a whole licence text. A version with build metadata after a plus
sign counts as a stable release.
@bensynapse
bensynapse merged commit 3a22ada into main Nov 12, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant