Welcome to the CMI-DAIR Template Python Repository! This template is designed to streamline your project setup and ensure a consistent structure. To get started, follow these steps:
- Run
setup_template.pyto initialize the repository. - Replace the content of this
README.mdwith details specific to your project. - Install the
pre-commithooks to ensure code quality on each commit. - Revise SECURITY.md to reflect supported versions or remove it if not applicable.
- Remove the placeholder src and test files, these are there merely to show how the CI works.
- If it hasn't already been done for your organization/acccount, grant third-party app permissions for CodeCov.
- To set up an API documentation website, after the first successful build, go to the
Settingstab of your repository, scroll down to theGitHub Pagessection, and selectgh-pagesas the source. This will generate a link to your API docs. - Update stability badge in
README.mdto reflect the current state of the project. A list of stability badges to copy can be found here. The node documentation can be used as a reference for the stability levels.
uvicorn cloaiservice.main:app