CMI-DAIR Template Python Repository

This is a template repository. Below is a checklist of things you should do to use it:

• Rewrite this README file, updating the badges as needed.
• Update the pre-commit versions in .pre-commit-config.yaml.
• Install the pre-commit hooks.
• Update the LICENSE file to your desired license and set the year.
• Replace "ENTER_YOUR_EMAIL_ADDRESS" in CODE_OF_CONDUCT.md
• Remove the placeholder src and test files, these are there merely to show how the CI works.
• Update pyproject.toml
• Update the name of src/APP_NAME
• Grant third-party app permissions (e.g. Codecov) here, if necessary.
• Either generate a CODECOV_TOKEN secret here (if its a private repository) or remove the line token: ${{ secrets.CODECOV_TOKEN }}

Project name

What problem does this tool solve?

Features

• A few
• Cool
• Things

Installation

Install this package via :

pip install template_python_repository

Or get the newest development version via:

pip install git+https://github.com/cmi-dair/template_python_repository

Quick start

Short tutorial, maybe with a

import template_python_repository

template_python_repository.short_example()

Links or References

• https://www.wikipedia.de