[issue_4] implement review comments

- add slash to directories in .gitignore
- make output from linter_and_formatting.sh consistent
- make black, isort, and flake8 dev-dependencies
- add configuration for pytest
- rename workflow
- add comment to clarify steps for poetry install

Signed-off-by: Meret Behrens <[email protected]>

.github/workflows/run_tests.yml → .github/workflows/lint_and_run_tests.yml

@@ -2,8 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-name: Install and Run tests
-
+name: Lint and Test
 on:
   push:
     branches:
@@ -45,6 +44,8 @@ jobs:
           path: .venv
           key: pydeps-${{ matrix.os}}-${{matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
 
+      # We use a cache for the projects dependencies but want to avoid caching the projects code.
+      # --no-root installs all dependencies but not the project itself which we do in the next step.
       - name: Install package dependencies
         run: poetry install --no-interaction --no-root
         if: steps.cache--deps.outputs.cache-hit != 'true'
@@ -96,6 +97,8 @@ jobs:
           path: .venv
           key: pydeps-${{ matrix.os}}-${{matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
 
+      # We use a cache for the projects dependencies but want to avoid caching the projects code.
+      # --no-root installs all dependencies but not the project itself which we do in the next step.
       - name: Install package dependencies
         run: poetry install --no-interaction --no-root
         if: steps.cache--deps.outputs.cache-hit != 'true'

.gitignore

@@ -1,13 +1,13 @@
-__pycache__
+__pycache__/
 
 # test
-.pytest_cache
+.pytest_cache/
 
 .DS_Store
 .idea/*
 .python-version
 .vscode/*
 
-.mypy_cache
+.mypy_cache/
 
-.venv
+.venv/

pyproject.toml

@@ -19,14 +19,13 @@ python = "^3.7"
 
 [tool.poetry.group.test.dependencies]
 pytest = "^6.0.0"
+
+[tool.poetry.group.typing.dependencies]
 black = "^23.1.0"
 isort = "^5.11"
 flake8 = "^5"
 mypy = "^1.1.1"
 
-[tool.poetry.group.typing.dependencies]
-mypy = ">=1.0"
-
 [virtualenvs]
 in-project = true
 
@@ -37,3 +36,6 @@ profile = "black"
 warn_return_any = true
 warn_unused_configs = true
 disallow_untyped_defs = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

scripts/linter_and_formatting.sh

@@ -11,6 +11,7 @@ echo "-----------------------"
 poetry run black src/ tests/
 
 echo "run flake"
+echo "-----------------------"
 poetry run flake8 src/ tests/
 
 echo "running mypy"