Merge pull request #166 from weberlab-hhu/additional_documentation #98

	name: Python CI

	on:
	push:
	branches: [ main ]
	pull_request:
	branches: [ main ]

	jobs:
	build:
	runs-on: ${{ matrix.os }}
	strategy:
	matrix:
	os: [ubuntu-latest]
	python-version: ['3.10']

	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 flake8 pytest
	pip install .
	if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

	- name: Lint with flake8
	run: \|
	# stop the build if there are Python syntax errors or undefined names
	flake8 helixer --count --select=E9,F63,F7,F82 --show-source --statistics
	# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
	flake8 helixer --count --exit-zero --max-complexity=10 --ignore=E501 --statistics

	- name: Test with pytest
	run: \|
	cd helixer
	pytest

Provide feedback