Skip to content

docs: record PyPI release candidate publication - #4

Merged
myheart521 merged 2 commits into
mainfrom
docs/pypi-publication-status
Jul 16, 2026
Merged

myheart521 merged 2 commits into
mainfrom
docs/pypi-publication-status

Conversation

@myheart521

Copy link
Copy Markdown
Owner

Summary

  • document the successful wamprobe==0.1.0rc1 PyPI Trusted Publishing run
  • make pip install wamprobe the default user quick start
  • add PyPI links and badge
  • record the clean public-index CLI/demo smoke
  • mark the PyPI installation acceptance item complete
  • keep the independent external-user smoke item open

Publication evidence

Verification

  • .venv/bin/python scripts/validate_repository.py
  • .venv/bin/mkdocs build --strict
  • .venv/bin/pytest -q — 76 passed
  • git diff --check

Copilot AI review requested due to automatic review settings July 16, 2026 02:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates project documentation to reflect the successful publication of the 0.1.0rc1 release candidate to PyPI via GitHub OIDC Trusted Publishing, and shifts the primary quick start path to pip install wamprobe.

Changes:

  • Add PyPI links/badge and update wording across docs to reflect the RC’s availability on PyPI.
  • Update quick start instructions to install from PyPI and run the CLI from an installed environment.
  • Record publication/smoke evidence and mark the PyPI install acceptance item complete in the plan.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
release/README.md Updates release/publishing notes to reflect successful PyPI Trusted Publishing verification.
README.md Adds PyPI badge/links and updates quick start to pip install wamprobe.
docs/WAMProbe_PLAN.md Records PyPI publication and marks the PyPI install acceptance checklist item complete.
docs/QUICKSTART.md Adds install-from-PyPI steps and switches demo invocation to the installed CLI.
docs/index.md Updates landing page to point users to pip install wamprobe and PyPI artifacts.
CHANGELOG.md Updates the RC entry to note PyPI publication via OIDC Trusted Publishing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/QUICKSTART.md Outdated
Comment thread release/README.md Outdated
Comment thread CHANGELOG.md Outdated
@myheart521
myheart521 merged commit f97b111 into main Jul 16, 2026
6 checks passed
@myheart521
myheart521 deleted the docs/pypi-publication-status branch July 16, 2026 02:12
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.

3 participants