Skip to content

README: CI badge; pyproject: align keywords with marketing brief#2

Merged
cigan1 merged 1 commit into
mainfrom
chore/readme-ci-badge-and-keywords
May 4, 2026
Merged

README: CI badge; pyproject: align keywords with marketing brief#2
cigan1 merged 1 commit into
mainfrom
chore/readme-ci-badge-and-keywords

Conversation

@cigan1

@cigan1 cigan1 commented May 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Two small discoverability fixes flagged during the siftfy.io SEO audit (Task 12 of the marketing brief).

What changed

  • README.md — CI build-status badge added between Python-versions and License. Of the brief's three required badges (PyPI version, build status, license), this was the only one not already shown.
  • pyproject.tomlkeywords extended with spam-api, spam-classification, and moderation. Existing entries (spam-classifier, api-client, siftfy, content-moderation, spam, spam-detection) stay — they don't hurt and a few are higher-traffic PyPI search terms than the brief's exact wording.

What was already done (and didn't need changes)

  • ✅ PyPI publication — pypi.org/pypi/siftfy/json returns 200; the package is live.
  • ✅ Trusted-publishing-on-tag workflow at .github/workflows/publish.yml (verifies tag matches _version.py before pushing).
  • ✅ README sections: install, quickstart, async, calibrated probabilities, errors (with retry semantics), configuration (with httpx.Client injection), resources, license.
  • ✅ MIT LICENSE file at root.
  • [project.urls] table: Homepage, Documentation, Source, Issues, Changelog.
  • ✅ CI matrix workflow runs ruff + mypy + pytest across 3.9–3.13.

Test plan

  • After merge, the CI badge in README renders green when the CI workflow is passing on main.
  • PyPI search for "spam-api" surfaces this package once the next version is published (keywords are baked into the wheel/sdist at build time, so they take effect on the next tagged release).

🤖 Generated with Claude Code

…keting brief

Two small discoverability fixes flagged during the siftfy.io SEO audit
(Task 12 of the marketing brief). Everything else from that checklist
is already in place: PyPI publication, trusted-publishing-on-tag
workflow, install/quickstart/async/errors/config/resources sections in
the README, MIT LICENSE file, project URLs.

- README.md: add a CI workflow badge between the Python-versions and
  License badges. Was the only one of the brief's three required
  badges (PyPI version, build status, license) that wasn't already
  shown.
- pyproject.toml keywords: add "spam-api", "spam-classification", and
  "moderation". Existing entries kept ("spam-classifier", "api-client",
  "siftfy") since they don't hurt and a couple are higher-traffic
  search terms on PyPI than the brief's wording.

No source / behaviour changes — README and metadata only.
@cigan1 cigan1 merged commit c1c2cf2 into main May 4, 2026
5 checks passed
@cigan1 cigan1 deleted the chore/readme-ci-badge-and-keywords branch May 4, 2026 20:56
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