Improve PyPI packaging metadata and README#32
Merged
Conversation
- Bump version to 0.3.0.dev0 for the next development cycle - Add keywords, Trove classifiers, and [project.urls] to pyproject.toml (no license classifier; License-Expression Apache-2.0 is used) - Rework README as the PyPI long description: PyPI/Python/License badges with absolute URLs, feature pip install as the primary method, fix the placeholder repository URL (your-org -> codelibs), point the LICENSE link to an absolute URL, normalize FESS_VERSION examples to 15.7.0, and refresh Docker image tags
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Polishes the package for PyPI publishing. The project ships the GitHub
README.mddirectly as the PyPI long description (readme = "README.md"inpyproject.toml), so this PR makes that file render and read well on the PyPI project page while keeping a single source of truth, and fills in the standard distribution metadata that was missing. It also bumps the version for the next development cycle.pyproject.toml0.2.0→0.3.0.dev0to open the next development cycle (PEP 440 canonical dev form).keywordsfor discoverability.classifiers(development status, console environment, intended audience, Python 3 / 3.13, OS, search/utilities topics). No license classifier is added on purpose — the project uses the SPDXlicense = "Apache-2.0"expression (setuptools ≥ 77, emitted asLicense-Expression), which is mutually exclusive with the deprecatedLicense ::classifier.[project.urls](Homepage, Repository, Issues, Documentation, Changelog) so the links appear in the PyPI sidebar.README.mdpip installas Method 1 (withpipx/uv toolvariants), since PyPI is the primary distribution channel; Docker and from-source methods follow.your-org→codelibsin thegit cloneexamples.LICENSElink (which 404s on PyPI) to an absolute GitHub URL, both in the license badge and the License section.FESS_VERSIONexample from15.6.1to15.7.0to match the code default and every other example.0.1.0to0.2.0.Verification
uv buildproducesfessctl-0.3.0.dev0sdist + wheel.twine check dist/*→ PASSED for both artifacts (confirms the README renders as the PyPI long description).METADATA: version0.3.0.dev0,License-Expression: Apache-2.0(no license classifier), all Project-URLs, keywords, classifiers, andDescription-Content-Type: text/markdownpresent.