diff --git a/README.md b/README.md index 10a01cdd..0d8cb7fd 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,8 @@ To update your Python project with the latest template: | `author_name`
"John Smith" | The full name of the primary author of the package. | | `author_email`
"john@example.com" | The email address of the primary author of the package. | | `python_version`
"3.8" | The minimum Python version that the package requires. | +| `processing_unit`
["CPU","GPU] | The processing unit we want to use for our application. We support CUDA Toolkit 11.8 with python versions 3.8, 3.9, 3.10. | + | `development_environment`
["simple", "strict"] | Whether to configure the development environment with a focus on simplicity or with a focus on strictness. In strict mode, additional [Ruff rules](https://beta.ruff.rs/docs/rules/) are added, and tools such as [Mypy](https://github.com/python/mypy) and [Pytest](https://github.com/pytest-dev/pytest) are set to strict mode. | | `with_conventional_commits`
["0", "1"] | If "1", [Commitizen](https://github.com/commitizen-tools/commitizen) will verify that your commits follow the [Conventional Commits](https://www.conventionalcommits.org/) standard. In return, `cz bump` may be used to automate [Semantic Versioning](https://semver.org/) and [Keep A Changelog](https://keepachangelog.com/). | | `with_fastapi_api`
["0", "1"] | If "1", [FastAPI](https://github.com/tiangolo/fastapi) is added as a run time dependency, FastAPI API stubs and tests are added, a `poe api` command for serving the API is added, and an `app` stage that packages the API is added to the Dockerfile. Additionally, the CI workflow will push the application as a Docker image instead of publishing the Python package. |