Skip to content

docs: show that da-cli is on PyPI - #12

Merged
FZ2000 merged 1 commit into
mainfrom
docs/pypi-badge
Aug 1, 2026
Merged

docs: show that da-cli is on PyPI#12
FZ2000 merged 1 commit into
mainfrom
docs/pypi-badge

Conversation

@FZ2000

@FZ2000 FZ2000 commented Aug 1, 2026

Copy link
Copy Markdown
Owner

Problem

The install instructions have been correct since #7, and #11 fixed what PyPI
says about the project. This fixes what the project says about PyPI.

Nothing above the fold indicated the package was installable. The badge row —
eight badges covering CI, Python, licence, ruff, mypy, coverage, status and
dependency count — never mentioned PyPI, so a visitor's first screen gave no
sign that pipx install da-sync existed. (The name does appear further down,
in the Install section; the gap was at the top.)

Solution

  • PyPI version badge, first in the row, linking to the project page.
  • pipx install da-sync directly under the opening paragraph.
  • Python 3.10+pypi/pyversions, which reads the classifiers instead
    of restating them, so it cannot drift from requires-python. It renders
    3.10 | 3.11 | 3.12 | 3.13 | 3.14 — strictly more than the static badge.
  • Dropped Status: Beta. The blockquote two lines below already says it
    with more detail.

That last one was forced, and the reason is worth recording: the badge row has
a budget. check_discoverability requires deviantart within the first twelve
source lines, and a ninth badge pushed the opening paragraph past it. Trimming
the duplicate beat widening the rule — that would have traded a real SEO
constraint for badge clutter.

Verification

  • All three new badge URLs were fetched and render real datapypi: v0.1.1 and python: 3.10 | 3.11 | 3.12 | 3.13 | 3.14 — not shields'
    invalid/undefined placeholder, which is what a wrong package name yields.
  • The opening-lines rule was watched failing: inserting a filler ninth
    badge reproduced FAIL 'deviantart' appears in the H1 or opening lines,
    27 passed / 1 failed. Restored, it is 28 passed / 0 failed.
  • check_doc_flags, check_doc_references, check_version_sync,
    check_discoverability — all pass.
  • markdownlint (pinned 0.45.0 + repo config) clean; lychee 0 errors.

Note

The badge will not appear on the PyPI page until the next release, since a
description is frozen into the uploaded artifact. That is cosmetic and not
worth a release on its own — 0.1.1's description is already correct.

🤖 Generated with Claude Code

The install instructions have been correct since #7, but nothing above the
fold said the package was installable. The badge row — eight badges for CI,
Python, licence, ruff, mypy, coverage, status and dependency count — never
mentioned PyPI at all, so a visitor's first screen gave no sign that
`pipx install da-sync` was an option.

* PyPI version badge, first in the row, linking to the project page.
* `pipx install da-sync` directly under the opening paragraph.
* `Python 3.10+` becomes `pypi/pyversions`, which reads the classifiers
  instead of restating them, so it cannot drift from `requires-python`.
  It renders "3.10 | 3.11 | 3.12 | 3.13 | 3.14" — strictly more than the
  static badge said.

The `Status: Beta` badge goes. The blockquote two lines below already says
"Status: Beta" with more useful detail, and the row turns out to have a
budget: check_discoverability requires "deviantart" inside the first twelve
lines, and a ninth badge pushed the opening paragraph past it. Trimming the
duplicate was the better fix; widening the rule would have traded a real SEO
constraint for badge clutter.

Verified: all three badge URLs render real data (pypi: v0.1.1, python:
3.10-3.14) rather than shields' "invalid" placeholder; the four checkers,
markdownlint (pinned 0.45.0 + repo config) and lychee are clean; and the
opening-lines rule was watched failing on a ninth badge before the trim.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@FZ2000
FZ2000 merged commit 2d67882 into main Aug 1, 2026
24 checks passed
@FZ2000
FZ2000 deleted the docs/pypi-badge branch August 1, 2026 22:38
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