Skip to content

Enrich PyPI project metadata (description, keywords, project.urls)#148

Merged
tmgbedu merged 1 commit into
mainfrom
task/pypi-packaging-682
Jul 8, 2026
Merged

Enrich PyPI project metadata (description, keywords, project.urls)#148
tmgbedu merged 1 commit into
mainfrom
task/pypi-packaging-682

Conversation

@tmgbedu

@tmgbedu tmgbedu commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Polishes the PyPI packaging metadata in fastapi_startkit/pyproject.toml so the published page is more discoverable and useful. Metadata-only — no dependency or version changes.

Changes ([project])

  • Richer description — replaced "Fastapi Starter kit components" with a descriptive one-liner covering the container, config, async ORM, facades, and Cleo console.
  • keywords — added a search-term list (fastapi, framework, async, orm, sqlalchemy, pydantic, ioc-container, dependency-injection, service-provider, cli, configuration, microservices, starter-kit, boilerplate, …).
  • [project.urls] — new block with verified real URLs:
    • Homepage / Documentation → https://fastapi-startkit.github.io (docs site, HTTP 200)
    • Repository → https://github.com/fastapi-startkit/fastapi-startkit-framework (canonical repo)
    • Issues → …/issues
    • Changelog → …/releases (project uses GitHub Releases; no CHANGELOG file)

Verification

  • uv build succeeds (sdist + wheel).
  • Inspected the generated wheel METADATA:
    • Summary: = new description
    • Keywords: = full list
    • Project-URL: entries present (Homepage, Documentation, Repository, Issues, Changelog)
  • git diff confirms only description, keywords, and [project.urls] changed — version and all dependencies untouched. No test/coverage config touched, so coverage is unaffected.

Add a richer project description, a keywords list, and a [project.urls]
block (Homepage, Documentation, Repository, Issues, Changelog) so the
PyPI page surfaces proper links and search terms. Verified via uv build
and the generated wheel METADATA. No dependency or version changes.

@tmgbedu tmgbedu left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Code review — APPROVE (posted as comment; GitHub blocks self-approval on own PR)

Metadata-only change to fastapi_startkit/pyproject.toml. Verified all requested points:

  • Scope: diff touches only [project] description, new keywords, and a new [project.urls] block. version (0.47.0) and all dependencies/optional-dependencies are untouched.
  • URLs: all resolve (HTTP 200) — Homepage & Documentation → https://fastapi-startkit.github.io, Repository → canonical repo, Issues → /issues, Changelog → /releases.
  • Description: accurate — matches the framework (service container, configuration, async-first ORM, facades, Cleo console).
  • Build: uv build succeeds (sdist + wheel). Wheel METADATA confirms Summary, Keywords, and 5× Project-URL entries.
  • Coverage: no test/coverage config touched — unaffected.

Non-blocking note: Homepage and Documentation intentionally point to the same docs site, which is fine.

No blocking issues. Recommended: merge.

@tmgbedu tmgbedu merged commit ef50bcb into main Jul 8, 2026
3 checks passed
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