Skip to content

Install from PyPI in the README; release 0.1.1 - #7

Merged
suffro merged 1 commit into
mainfrom
v0.1.1-pypi-readme
Sep 25, 2026
Merged

suffro merged 1 commit into
mainfrom
v0.1.1-pypi-readme

Conversation

@suffro

@suffro suffro commented Sep 25, 2026

Copy link
Copy Markdown
Owner

The README is also the PyPI project page, and the 0.1.0 page tells people to git clone and uv tool install .. This PR fixes that, and bumps to 0.1.1 because PyPI does not allow editing the description of a version that is already published.

  • Install section: pip install decguard / uv tool install decguard. The quickstart clones the repository only to get the example files.
  • Links: all 15 relative links (docs/…, CONTRIBUTING.md, CHANGELOG.md) are now absolute GitHub URLs. Relative links 404 on PyPI.
  • Status line: it no longer says "not yet tagged or published".
  • CI snippets: in the README and docs/ci.md they install from PyPI instead of git+https://….
  • Version: 0.1.1 in pyproject.toml, uv.lock and CHANGELOG. .context/state/current.md records the 0.1.0 release.

Checks: ruff check, ruff format --check, mypy and pytest pass (313 passed, 8 opt-in skips). uv build succeeds and twine check --strict passes, which means the README renders on PyPI.

🤖 Generated with Claude Code

The README is the PyPI project page, so it now installs with
`pip install decguard` / `uv tool install decguard` instead of cloning,
and its links are absolute GitHub URLs that work on PyPI. The CI examples
install from PyPI. Bump to 0.1.1 so PyPI shows the corrected page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Failed ❌

View logs ↗
01ac46a 2026-09-25T00:42:24.468Z View logs ↗

@suffro
suffro merged commit 20b6b02 into main Sep 25, 2026
8 of 9 checks passed
@suffro
suffro deleted the v0.1.1-pypi-readme branch September 25, 2026 00:49
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