docs: fix readme facts and license metadata - #55
Merged
Merged
Conversation
- Drop the link to modern-python-template, which does not exist - Open the description with the pyproject description - Separate linting/formatting (ruff) from type checking (ty) - Use an absolute LICENSE link like the other org repos - Sentence-case headings and fix the skipped heading level - Use the SPDX id "MIT" for the pyproject license
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
Fixes factual and style problems in the readme, plus a non-SPDX license string in pyproject.
Changes
gh api repos/modern-python/modern-python-template). Sentence removed;.copier-answers.ymlleft untouched.ruff, type checking withty".LICENSErelatively; now absolute, matching the other org repos.git clonerun" became##(the page had no##before the first###).license = "MIT License"is not an SPDX expression:packaging.licenses.canonicalize_license_expression("MIT License")raises, andvalidate-pyproject(with packaging>=24.2) rejects the file. 27 other org repos use"MIT". With"MIT"the file validates anduv lock --checkpasses.Checklist
ruff)ty)uv build) if packaging or build config changeddescription, profile blurb) if this touches packaginguv buildfails the same way on main (setuptools flat-layout discovery, no build-system table), so it could not confirm the metadata;validate-pyprojectwas used instead. Tests ran against a throwaway postgres:14 container: 31 passed, 100% coverage.