Skip to content

Document and lock the supported library API - #78

Merged
QuiteYellow merged 3 commits into
QuiteYellow:mainfrom
Moballo-LLC:codex/public-api-contract
Sep 6, 2026
Merged

Document and lock the supported library API#78
QuiteYellow merged 3 commits into
QuiteYellow:mainfrom
Moballo-LLC:codex/public-api-contract

Conversation

@Jason-Morcos

@Jason-Morcos Jason-Morcos commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

This is the last of my planned PRs to this repo to share the key findings that allowed me to access my devices!

What changes

  • documents the supported module-by-module API for errors, authentication,
    sessions, probes, endpoint discovery, all three CoAP carriers, OwnerPSK, and
    the reusable OCF cache/worker helpers;
  • documents the additive 0.1.x compatibility policy, including the existing
    certificate constructor pairs and provider-preferred path;
  • records the caller-owned session/threading lifecycle and keeps credential,
    ownership, and Home Assistant policy outside the helper modules;
  • expands the public compatibility test to import the exact symbols exercised
    by LocalThings, the reference bridge, and the downstream integration;
  • asserts that the root packages remain intentionally free of duplicate
    re-exports;
  • syntax-checks every Python example in the README; and
  • moves the reference bridge's fmt_code import to its canonical coap
    module without changing behavior.

There is no new runtime facade and no transport behavior change in this
commit.

Validation

  • 717 tests pass on Python 3.14
  • all README Python blocks compile
  • wheel and sdist build, contain the expected tracked files, and pass the
    distribution checker
  • share-safety check passes against Add opt-in HVR-only peer cleanup #77's head

Merge order

This is stacked on #77, which is stacked on #76. Please merge in this order:

  1. Add authenticated server identity discovery #76 — authenticated first-use server identity
  2. Add opt-in HVR-only peer cleanup #77 — opt-in HVR-only peer cleanup
  3. this PR — PY-18 import contract and release documentation

The GitHub diff currently includes the earlier commits. After #76 and #77
merge, this PR reduces to commit 0660924. #74 is independent and can merge at
any point.

@Jason-Morcos
Jason-Morcos force-pushed the codex/public-api-contract branch from c17d219 to 0660924 Compare August 31, 2026 22:29
@QuiteYellow
QuiteYellow merged commit d01dad7 into QuiteYellow:main Sep 6, 2026
8 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.

2 participants