Correct the README to the plugin surface #25

Merged

tiagoagueda merged 1 commit from 10-readme-http into main

2026-11-12 04:16:39 +00:00

tiagoagueda commented

2026-11-11 22:58:46 +00:00

Owner

Closes #10

The README names postulo.plugins.api.client() instead of a module the surface check refuses, lists all twelve entry-point groups, points at the wiki's Writing-a-plugin page, and lists every place a rename touches. A test refuses the README naming any core module other than the surface.

🤖 Generated with Claude Code

Closes #10 The README names `postulo.plugins.api.client()` instead of a module the surface check refuses, lists all twelve entry-point groups, points at the wiki's Writing-a-plugin page, and lists every place a rename touches. A test refuses the README naming any core module other than the surface. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

tiagoagueda added 1 commit

2026-11-11 22:58:46 +00:00

Correct the README to the plugin surface, and list every place a rename touches

CI / test (pull_request) Successful in 2m52s

Details

CI / Audit the locked dependencies (pull_request) Failing after 2m23s

Details

70f6e8f998

This is the repository authors copy, and its README told them to use
postulo.plugins.http.client() in the sentence after the rule that forbids importing past
postulo.plugins.api; the surface check in tests/test_surface.py refuses exactly that
import. client has been on postulo.plugins.api since postulo/postulo#229, which is what
notifier.py already names. The README now says postulo.plugins.api.client().

Read against the core's main, two more statements no longer held. The entry-point groups
were four of the twelve the registry reads (base.CONNECTED_KINDS and the *_GROUP names):
all twelve are listed, with the note that the class each expects is on the surface. And
docs/PLUGINS.md is now a stub pointing at the wiki's Writing a plugin, so the README and
the "Writing a plugin" project URL point there.

"Make it yours" said only to rename the package. The distribution's name is in
pyproject.toml and in the version() call in __init__.py, and renaming one without the
other fails the import with PackageNotFoundError (or reports another plugin's version).
Step 1 now names every file a rename touches. Deriving the name with
packages_distributions() was tried and does not work: the editable install uv sync
makes records no package for the distribution, so the string stays, and a test holds it
to [project] name.

Two tests: the README names no Postulo module but the surface and postulo.plugins.testing
(it fails on the old README with postulo.plugins.http.client), and the name passed to
version() is [project] name (it fails when pyproject.toml alone is renamed).

Closes #10

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

tiagoagueda force-pushed 10-readme-http from 70f6e8f998

CI / test (pull_request) Successful in 2m52s

Details

CI / Audit the locked dependencies (pull_request) Failing after 2m23s

Details

to 97d0b4eca2

CI / Audit the locked dependencies (pull_request) Successful in 2m24s

Details

CI / test (pull_request) Successful in 3m13s

Details

2026-11-12 02:07:25 +00:00

Compare