Project		Status
CI/CD
Quality
Package
Community
Meta

project-template

Template repository for packages belonging to @litestar-org organization.

Usage:

• Pick this template in GitHub.
• Rename the src/project_template package to your project's name and update the name in pyproject.toml and any imports to match (hatchling auto-discovers src/<project_name>).
• Run pre-commit install && pre-commit autoupdate
• Update pyproject.toml with your dependencies and run uv lock to refresh the lock file.
• Update the project description, keywords, author, maintainers etc. in pyproject.toml

Local development

This project uses uv for package and environment management.

uv sync --all-groups          # install runtime + docs/lint/test groups
uv run pytest                 # run tests
uv run pre-commit run -a      # lint
uv lock --upgrade             # upgrade locked deps

# Equivalent Makefile shortcuts
make install
make test
make lint
make upgrade

Docs

Important

TODO

Sonar

• Import the repository into sonarcloud and update the sonar properties file to use the correct project key.

Release

• Increment the version in pyproject.toml according to the versioning scheme
• Draft a new release on GitHub
  • Use vMAJOR.MINOR.PATCH (e.g. v1.2.3) as both the tag and release title
    • The version should follow semantic versioning and PEP 440.
  • Fill in the release description. You can use the "Generate release notes" function to get a draft for this
• Commit your changes and push to main
• Publish the release
• Go to Actions and approve the release workflow
• Check that the workflow runs successfully