Skip to content

docs: pre-PyPI README refresh for release-frozen long_descriptions - #190

Merged
mikemcdougall merged 1 commit into
trunkfrom
docs/readme-refresh-prepypi
Aug 5, 2026
Merged

docs: pre-PyPI README refresh for release-frozen long_descriptions#190
mikemcdougall merged 1 commit into
trunkfrom
docs/readme-refresh-prepypi

Conversation

@mikemcdougall

Copy link
Copy Markdown
Contributor

Why now

This must merge before release PR #153. packages/honua-sdk/README.md and packages/honua-admin/README.md are the PyPI long_description — whatever is on trunk when the python-sdk-v0.1.10 / python-admin-v0.1.7 tags push gets frozen into the published artifacts, and fixing them afterwards costs another release. Both pyproject.toml Homepage URLs 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

  • Add an Alpha (0.x) status notice matching the Development Status :: 3 - Alpha classifier (previously the classifier said Alpha while the README said nothing).
  • Replace the test_service placeholder in the flagship example with the parcels example used by the root README and examples/protocol_clients.py; show output and the result.to_geodataframe() one-liner.
  • Document the [raster] extra (was missing; only [grpc]/[geopandas] were listed) plus the combined-extras install.
  • Mention the honua-migrate ArcPy migration CLI this package ships (scan / translate / run / .pyt / .atbx / GP-service classification — verified against honua_sdk/migration/_cli.py).
  • Add the shipped-but-unlisted protocol surfaces: OGC API Records, SceneServer (client.scenes()), ElevationServer (client.elevation()).
  • Fix the "Honua Server" link (pointed at the GitHub org page, not 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 offline scan_arcpy_script() / scan_arcpy_source() helpers. Same Alpha notice, docs-site links, and server-repo link fix.

pyproject.toml (both packages)Homepage now points at https://honua.io instead of the GitHub org page (this is PyPI's sidebar link); added a Documentation URL for the live docs site. Repository/Issues unchanged. TOML validated with tomllib.

Release-proofing the repo docs

README.md + INSTALL.md

  • Replace the "Not yet published to PyPI" claims — which flip false the moment the chore: release trunk #153 tag pushes — with release-proof phrasing: PyPI commands shown as canonical, with a conditional "if these do not resolve yet, the first release is staged; install from source" that reads correctly both before and after publish.
  • Drop the hardcoded honua-sdk 0.1.9 / honua-admin 0.1.6 versions from the Status prose (guaranteed staleness on every release).
  • Link the live rendered docs site https://honua-io.github.io/honua-sdk-python/latest/ (verified 200) instead of "browsable on GitHub", and add the docs badge that docs.yml claims exists.
  • De-link honua-qgis-plugin in Related repos (repo is PRIVATE — 404 for every external reader); now plain text noting private preview.
  • Note that the git+...@python-sdk-v0.1.9 pin should be replaced with the newest python-sdk-v* tag; fix the ./packages/... install comment inside the quick-start sample; replace remaining test_service placeholders in INSTALL.md.
  • Extend the protocol/CLI/quality-gate feature rows to match shipped code (OGC Maps/Tiles/Coverages/Processes/Records, Scene/Elevation servers, 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

All edited files verified against current trunk before editing; mkdocs strict build unaffected (root README/INSTALL are outside docs_dir).

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.
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@mikemcdougall
mikemcdougall merged commit 217dbb3 into trunk Aug 5, 2026
26 of 28 checks passed
@mikemcdougall
mikemcdougall deleted the docs/readme-refresh-prepypi branch August 5, 2026 00:40
@github-actions github-actions Bot mentioned this pull request Aug 5, 2026
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