CMI-DAIR Template Python Repository

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.py to initialize the repository.
• Replace the content of this README.md with details specific to your project.
• Install the pre-commit hooks 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 Settings tab of your repository, scroll down to the GitHub Pages section, and select gh-pages as the source. This will generate a link to your API docs.
• Update stability badge in README.md to 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.

Project name

What problem does this tool solve?

Features

• A few
• Cool
• Things

Installation

Install this package via :

pip install APP_NAME

Or get the newest development version via:

pip install git+https://github.com/childmindresearch/template-python-repository

Quick start

Short tutorial, maybe with a

import APP_NAME

APP_NAME.short_example()

Links or References

• https://www.wikipedia.de