Template repository for packages belonging to Starlite-API org.
Usage:
- Pick this template in GitHub.
- If you don't want to use the
src
folder, rename it and replace all references tosrc
with the new target folder. - Run
pre-commit install && pre-commit autoupdate
- Update pyproject.toml with your dependencies and run
poetry update
to create a lock file. - Update the project description, keywords, author, maintainers etc. in pyproject.toml
Update the mkdocs.yml
file to point at the repository and docs site by replacing all places that have values
inside brackets, e.g. <repo>.
- Import the repository into sonarcloud and update the sonar properties file to use the correct project key.
- Add the
SONAR_TOKEN
secret in GitHub as an action secret.
- To release you need to set the
PYPI_TOKEN
value in GitHub.