Skip to content

docs: fix readme facts and license metadata - #55

Merged
lesnik512 merged 2 commits into
mainfrom
docs/fix-facts
Oct 3, 2026
Merged

lesnik512 merged 2 commits into
mainfrom
docs/fix-facts

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Summary

Fixes factual and style problems in the readme, plus a non-SPDX license string in pyproject.

Changes

  • readme.md:29 linked https://github.com/modern-python/modern-python-template, which returns 404 (gh api repos/modern-python/modern-python-template). Sentence removed; .copier-answers.yml left untouched.
  • readme.md:18 said "Production-ready dockerized async REST API on ..." while pyproject.toml:4 describes the repo as a template. The description now opens with the pyproject string, reworded into a sentence. Also spells "Litestar" (was "LiteStar").
  • readme.md:24 said ruff and ty do linting and formatting; ty is a type checker. Now "Linting and formatting with ruff, type checking with ty".
  • readme.md:36 linked LICENSE relatively; now absolute, matching the other org repos.
  • Headings: "Key Features" is sentence case; "### Description" and "### After git clone run" became ## (the page had no ## before the first ###).
  • pyproject.toml:10 license = "MIT License" is not an SPDX expression: packaging.licenses.canonicalize_license_expression("MIT License") raises, and validate-pyproject (with packaging>=24.2) rejects the file. 27 other org repos use "MIT". With "MIT" the file validates and uv lock --check passes.

Checklist

  • Lint and format pass (ruff)
  • Type check passes (ty)
  • Tests pass and new behavior is covered
  • Build succeeds (uv build) if packaging or build config changed
  • Repo metadata stays consistent across the three surfaces (GitHub description, pyproject description, profile blurb) if this touches packaging

uv build fails the same way on main (setuptools flat-layout discovery, no build-system table), so it could not confirm the metadata; validate-pyproject was used instead. Tests ran against a throwaway postgres:14 container: 31 passed, 100% coverage.

- 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
@lesnik512
lesnik512 merged commit 0dd4326 into main Oct 3, 2026
2 checks passed
@lesnik512
lesnik512 deleted the docs/fix-facts branch October 3, 2026 13:58
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