Skip to content

docs(sdk): translate the README to English and drop the stale PyPI list - #340

Merged
MoltyCel merged 1 commit into
mainfrom
docs/sdk-readme-english
Sep 6, 2026
Merged

docs(sdk): translate the README to English and drop the stale PyPI list#340
MoltyCel merged 1 commit into
mainfrom
docs/sdk-readme-english

Conversation

@MoltyCel

@MoltyCel MoltyCel commented Sep 6, 2026

Copy link
Copy Markdown
Owner

The SDK README was still German throughout — not only the PyPI line. Content is carried over one to one; every identifier, code block, table and link stays as it was.

Factual correction. The PyPI paragraph claimed 0.1.0, 0.2.0 and 0.3.0 were published and 0.4.0 was not. Live state:

latest:   0.5.0
releases: 0.1.0, 0.2.0, 0.3.0, 0.4.0, 0.5.0

The paragraph no longer lists versions — a hard-coded list goes stale with the next release. It points at the latest release on PyPI plus the property that distinguishes it, and defers the detail to the note above it and the CHANGELOG.

Quickstart checked against 0.5.0. EnforceClient, .check(), .verify(response, mandate, transaction), enforce_check, action_digest, build_bundle, f_ext and verify_record are all exported unchanged; on_transport_error still takes "deny"/"raise", on_pending still takes a callable. _core.py has ENFORCE_VERSION = "3.0" and returns {verdict, reason, grant_index, trace, core, core_digest}reason is on the response, and the core field list excludes it, which is what the README says.

Scope. One file. git status shows M sdk/python/README.md and nothing else. No build, no publish.

German-residue regex over the result: 4 raw hits, all false positives — three English was and the MIT of the license line matching mit case-insensitively. No umlauts, no ß.

The README was still German throughout. Content is carried over one to one;
every identifier, code block, table and link stays as it was.

One factual correction: the PyPI paragraph still claimed 0.1.0 to 0.3.0 were
published and 0.4.0 was not. 0.1.0 through 0.5.0 are on PyPI and 0.5.0 is
current. The paragraph no longer lists versions at all — a hard-coded list goes
stale with the next release — and points at the latest release plus the
property that distinguishes it: the digested core carries no free text.

The quickstart was checked against the 0.5.0 surface. EnforceClient.check,
EnforceClient.verify, enforce_check, action_digest, build_bundle, f_ext and
verify_record are exported unchanged, and reason is still on the response,
outside the core.
@MoltyCel
MoltyCel merged commit c02fcc1 into main Sep 6, 2026
14 checks passed
@MoltyCel
MoltyCel deleted the docs/sdk-readme-english branch September 6, 2026 13:43
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