🎉An initial Draft

.github/workflows/black.yml

@@ -0,0 +1,16 @@
+name: "Black"
+
+on: [push]
+jobs:
+  black:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.9]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Black Code Formatter
+        uses: lgeiger/[email protected]
+        with:
+          args: ". --check"

.github/workflows/coverage.yml

@@ -0,0 +1,23 @@
+name: "Coverage"
+
+on: [push]
+jobs:
+  coverage:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.9]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run Tests and Record Coverage
+        run: |
+          tox -e coverage

.github/workflows/pythonlint.yml

@@ -0,0 +1,24 @@
+name: "Linting"
+
+on: [push]
+jobs:
+  pylint:
+    name: Python Code Quality and Lint
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.9]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run Pylint via Tox
+        run: |
+          tox -e linting

.github/workflows/unittests.yml

@@ -0,0 +1,23 @@
+name: "Unittests"
+
+on: [push]
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.9]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run the Unit Tests via Tox
+        run: |
+          tox -e tests

.gitignore

@@ -0,0 +1,134 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.idea/
+
+# vscode settings
+.vscode/

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 20.8b1 # Replace by any tag/version: https://github.com/psf/black/tags
+    hooks:
+      - id: black
+        language_version: python3

README.md

@@ -1,2 +1,66 @@
-# python_template_repository
-A template repository that comes up with a pre-defined tox setup and CI actions. 
+# Python Template Repository including Unittests, Linting Actions and Coverage measurements
+<!--- you need to replace the `organization/repo_name` in the status badge URLs --->
+![Unittests status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Unittests/badge.svg)
+![Coverage status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Coverage/badge.svg)
+![Linting status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Linting/badge.svg)
+![Black status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Black/badge.svg)
+
+This is a template repository. It doesn't contain any useful code but only a minimal working setup for a Python project including:
+
++ a basic **project structure** with
+    + tox.ini
+    + requirements.in
+    + and a requirements.txt derived from it
+    + an example class
+    + an example unit test (using pytest)
++ ready to use **Github Actions** for
+    + [pytest](https://pytest.org)
+    + [code coverage measurement](https://coverage.readthedocs.io) (fails below 80% by default)
+    + [pylint](https://pylint.org/) (only accepts 10/10 code rating by default)
+    + [black](https://github.com/psf/black) code formatter check
+      using [lgeiger/black-action](https://github.com/lgeiger/black-action)
+
+By default it uses Python version 3.9.
+
+## How to use this Repository on Your Machine
+
+This introduction assumes that you have tox installed already (
+see [installation instructions](https://tox.readthedocs.io/en/latest/install.html)) and that a `.toxbase` environment
+has been created.
+
+If this is the case, clone this repository and create the `dev` environment on your machine.
+
+```bash
+tox -e dev
+```
+
+### How to use with PyCharm
+
+1. Create a new project using existing sources with your local working copy of this repository as root directory. Choose
+   the path `your_repo/.tox/dev/` as path of the "previously configured interpreter".
+2. Set the
+   default [test runner of your project](https://www.jetbrains.com/help/pycharm/choosing-your-testing-framework.html) to
+   pytest.
+3. Set
+   the [working directory of the unit tests](https://www.jetbrains.com/help/pycharm/creating-run-debug-configuration-for-tests.html)
+   to the project root (instead of the unittest directory)
+
+### How to use with VS Code
+
+1. Open the folder with VS Code.
+2. **Select the python interpreter** which is created by tox. Open the command pallett with `CTRL + P` and type `Python: Select Interpreter`. Select the interpreter which is placed in `.tox/dev/Scripts/python.exe` under Windows or `.tox/dev/bin/python` under Linux and macOS.
+3. **Setup pytest and pylint**. Therefore we open the file `.vscode/settings.json` which should be automatically generated during the interpreter setup. Insert the following lines into the settings:
+```json
+    "python.testing.unittestEnabled": false,
+    "python.testing.nosetestsEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "pythonTestExplorer.testFramework": "pytest",
+    "python.testing.pytestArgs": [
+        "unittests"
+    ],
+    "python.linting.pylintEnabled": true
+```
+4. Enjoy 🤗
+
+## Contribute
+You are very welcome to contribute to this template repository by opening a pull request against the main branch.

mymodule.py

@@ -0,0 +1,22 @@
+"""
+This a docstring for the module.
+"""
+
+
+class MyClass:  # pylint: disable=too-few-public-methods
+    """
+    This is a docstring for the class.
+    """
+
+    def __init__(self):
+        """
+        Initialize for the sake of initializing
+        """
+        self.my_instance_var = "abc"
+
+    def do_something(self) -> str:
+        """
+        Actually does nothing.
+        :return: the value of an instance variable
+        """
+        return self.my_instance_var

pyproject.toml

@@ -0,0 +1,5 @@
+[tool.black]
+line-length = 120
+
+[tool.isort]
+line_length = 120

requirements.txt

@@ -0,0 +1,6 @@
+#
+# This file is autogenerated by pip-compile
+# To update, run:
+#
+#    pip-compile requirements.in
+#

tox.ini

@@ -0,0 +1,49 @@
+[tox]
+envlist = 
+     tests
+     linting
+     coverage
+skip_missing_interpreters = True
+skipsdist = True
+
+[testenv]
+commands = python -m pip install --upgrade pip
+
+[testenv:dev]
+# the dev environment contains everything you need to start developing on your local machine.
+deps =
+    black
+    pip-tools
+    pylint
+    pytest
+    pre-commit
+commands =
+    python -m pip install --upgrade pip
+    pip-compile requirements.in
+    pip install -r requirements.txt
+
+[testenv:tests]
+# the tests environment is called by the Github action that runs the unit tests
+deps =
+    -rrequirements.txt
+    pytest
+commands = python -m pytest --basetemp={envtmpdir} {posargs}
+
+[testenv:linting]
+# the linting environment is called by the Github Action that runs the linter
+deps =
+    -rrequirements.txt
+    pylint
+    # add your fixtures like e.g. pytest_datafiles here
+commands =
+    pylint mymodule.py
+    # add single files (ending with .py) or packages here
+
+[testenv:coverage]
+# the coverage environment is called by the Github Action that runs the coverage measurement
+deps = 
+    {[testenv:tests]deps}
+    coverage
+commands =
+    coverage run -m pytest --basetemp={envtmpdir} {posargs}
+    coverage report --fail-under 80 --omit .tox/*,unittests/*