docs: pre-PyPI README refresh for release-frozen long_descriptions - #190
Merged
Conversation
Release PR #153 freezes packages/*/README.md into the PyPI artifacts, so fix the PyPI-rendered files and release-proof the repo docs before it merges: - packages/honua-sdk/README.md: add an Alpha (0.x) status notice matching the Development Status :: 3 - Alpha classifier; replace the test_service placeholder with the parcels example used elsewhere; show result output and to_geodataframe(); document the [raster] extra and the combined extras install; mention the honua-migrate ArcPy migration CLI (scan / translate / .pyt / .atbx / GP-service) and the missing protocol surfaces (OGC Records, SceneServer, ElevationServer); link the rendered docs site and sibling SDKs; point the Honua Server link at honua-io/honua-server instead of the org page. - packages/honua-admin/README.md: rewrite the stale stub grounded in the actual client surface (services, layers, connections + encryption, styles, metadata resources, manifest export/apply with dry-run/prune, scan_migration_source, offline scan_arcpy_script helpers); add the same Alpha notice, docs-site links, and server-repo link fix. - pyproject.toml (both packages): Homepage now points at honua.io instead of the GitHub org page; add a Documentation URL for the live docs site. - README.md + INSTALL.md: replace the 'Not yet published to PyPI' wording with release-proof phrasing (PyPI is canonical; from-source always works), drop hardcoded package versions from Status, link the live versioned docs site and add a docs badge, list missing doc pages, note the git-tag pin should track the newest python-sdk-v* tag, de-link the private honua-qgis-plugin repo, replace remaining test_service placeholders, and extend the protocol/CLI/quality-gate feature rows to match shipped code.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Merged
9 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why now
This must merge before release PR #153.
packages/honua-sdk/README.mdandpackages/honua-admin/README.mdare the PyPIlong_description— whatever is on trunk when thepython-sdk-v0.1.10/python-admin-v0.1.7tags push gets frozen into the published artifacts, and fixing them afterwards costs another release. Bothpyproject.tomlHomepageURLs are likewise baked into the release metadata. This PR fixes the audit findings from the 2026-08-04 README audit; it does not touch version numbers, CHANGELOG.md, or release-please files.PyPI-rendered files (release-frozen)
packages/honua-sdk/README.md
0.x) status notice matching theDevelopment Status :: 3 - Alphaclassifier (previously the classifier said Alpha while the README said nothing).test_serviceplaceholder in the flagship example with theparcelsexample used by the root README andexamples/protocol_clients.py; show output and theresult.to_geodataframe()one-liner.[raster]extra (was missing; only[grpc]/[geopandas]were listed) plus the combined-extras install.honua-migrateArcPy migration CLI this package ships (scan/translate/run/.pyt/.atbx/ GP-service classification — verified againsthonua_sdk/migration/_cli.py).client.scenes()), ElevationServer (client.elevation()).honua-io/honua-server); link the live docs site and sibling SDKs.packages/honua-admin/README.md — rewritten (untouched since 2026-05-25, read like an internal stub). Every claim grounded in
honua_admin/_client.py/__init__.py: compatibility-first capability gating, services, layers + table discovery, connections with encryption validate/rotate, OGC + per-layer styles, metadata-resource CRUD, manifest export/apply with dry-run/prune,scan_migration_source()(POST /api/v1/admin/import/scan), and the offlinescan_arcpy_script()/scan_arcpy_source()helpers. Same Alpha notice, docs-site links, and server-repo link fix.pyproject.toml (both packages) —
Homepagenow points at https://honua.io instead of the GitHub org page (this is PyPI's sidebar link); added aDocumentationURL for the live docs site.Repository/Issuesunchanged. TOML validated withtomllib.Release-proofing the repo docs
README.md + INSTALL.md
honua-sdk 0.1.9 / honua-admin 0.1.6versions from the Status prose (guaranteed staleness on every release).docs.ymlclaims exists.honua-qgis-pluginin Related repos (repo is PRIVATE — 404 for every external reader); now plain text noting private preview.git+...@python-sdk-v0.1.9pin should be replaced with the newestpython-sdk-v*tag; fix the./packages/...install comment inside the quick-start sample; replace remainingtest_serviceplaceholders in INSTALL.md.honua-migrate.atbx/GP-service subcommands, the sdk-coverage snapshot gate) and list missing doc pages (pagination, retries, diagnostic bundles, sdk-coverage).Not in scope
packages/honua-gp/README.mdlayout-tree staleness (unpublished package; audit ranked non-blocking).All edited files verified against current trunk before editing; mkdocs strict build unaffected (root README/INSTALL are outside
docs_dir).