Introduce black code formatting

.flake8

@@ -0,0 +1,11 @@
+[flake8]
+# Recommend matching the black line length (default 88),
+# rather than using the flake8 default of 79:
+max-line-length = 88
+# Q003 Change outer quotes to avoid escaping inner quotes
+# W503 Line break before binary operator (preferred way)
+# E203 See https://github.com/PyCQA/pycodestyle/issues/373
+extend-ignore = "Q003,W503,E203"
+# flake8-use-fstring
+percent-greedy = 0
+format-greedy = 2

.vscode/settings.json

@@ -6,7 +6,7 @@
     ],
     "editor.tabSize": 4,
     "editor.insertSpaces": true,
-    "editor.wordWrapColumn": 80,
+    "editor.wordWrapColumn": 88,
     "editor.wordWrap": "wordWrapColumn",
     "files.trimTrailingWhitespace": true,
     "files.insertFinalNewline": true,

Makefile

@@ -52,14 +52,17 @@ isort-apply:
 
 mypy:
 	@echo Run static code checks against source code base
-	$(POETRY_CMD) run mypy my_module
-	$(POETRY_CMD) run mypy tests
+	$(POETRY_CMD) run mypy $(PY_FILES)
+
+black:
+	@echo Run code formatting using black
+	$(POETRY_CMD) run black $(PY_FILES)
 
 lint:
 	@echo Run code formatting checks against source code base
 	$(POETRY_CMD) run flake8 $(PY_FILES)
 
-build: test mypy isort lint
+build: test mypy isort black lint
 	@echo Run setup.py-based build process to package application
 	$(POETRY_CMD) build
 

README.md

@@ -2,12 +2,6 @@
 
 > A best-practices template project for Python3 modules
 
---------------------------------------------------------------------------------
-
-**Disclaimer**: If you see this on [pypi.org](https://pypi.org/project/python3-boilerplate/) please note that the project is only published here for testing purposes. Please visit [GitHub](https://github.com/BastiTee/python3-boilerplate) for the related template project.
-
---------------------------------------------------------------------------------
-
 ## Setup
 
 - Make sure that `python` and `poetry` is installed and available on the path. Python 2 is not supported – :skull:
@@ -18,8 +12,9 @@
 ## Features
 
 - Basic project/module organization according to <https://packaging.python.org>
-- `Makefile` bootstrapping script
+- Makefile bootstrapping script
 - [poetry](https://python-poetry.org/) with virtual environments and project builds
+- [black](https://github.com/psf/black) code formatting
 - Unit testing with [pytest](https://docs.pytest.org/en/latest/)
 - Linting ([flake8](http://flake8.pycqa.org)) and code formatting ([autopep8](https://github.com/hhatto/autopep8)) support
 - [isort](https://pypi.org/project/isort/) support for automated import sorting
@@ -41,8 +36,8 @@
 
 ## Future ideas and todos
 
-- Introduce [black](https://github.com/psf/black) in favour of other linters
-- Introce Python 3.7 and Python 3.10 to test matrix
+- Introduce Python 3.7 and Python 3.10 to test matrix
+- Embed flake8 config into `pyproject.toml` once they support it ([see](https://github.com/PyCQA/flake8/issues/234))
 
 ## Licensing
 

my_module/__main__.py

@@ -13,13 +13,10 @@
 @click.command('my_module')
 @click.option('--number-a', '-a', type=click.INT, default=2)
 @click.option('--number-b', '-b', type=click.INT, default=2)
-def main(
-    number_a: int,
-    number_b: int
-) -> None:
+def main(number_a: int, number_b: int) -> None:
     """Enter main application."""
     print('Executed from command line...')
-    print(f'2 + 2 equals {add_two_numbers(number_a, number_b)}')
+    print(f'{number_a} + {number_b} equals {add_two_numbers(number_a, number_b)}')
 
 
 if __name__ == '__main__':

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "my_module"
-version = "0.0.6"
+version = "0.0.7"
 description = ""
 license = "Apache 2.0"
 authors = ["Basti Tee <basti.tee@posteo.de>"]
@@ -38,6 +38,7 @@ rope = "^1.0.0"
 twine = "^4.0.0"
 mypy = "^0.950"
 typing-extensions = "^4.2.0"
+black = "^22.3.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
@@ -62,10 +63,5 @@ warn_unreachable = true
 [tool.pytest]
 addopts = "-p no:warnings"
 
-[tool.flake8]
-# Q003 Change outer quotes to avoid escaping inner quotes
-# W503 line break before binary operator (preferred way)
-ignore = "Q003,W503"
-# flake8-use-fstring
-percent-greedy = 0
-format-greedy = 2
+[tool.black]
+skip-string-normalization = true

tests/test_utils.py

@@ -18,14 +18,11 @@
 
 
 class TestUtils:  # noqa: D101
-
-    @pytest.mark.parametrize('number_left, number_right', [
-        (None, 1), (1, None), (None, None)
-    ])
+    @pytest.mark.parametrize(
+        'number_left, number_right', [(None, 1), (1, None), (None, None)]
+    )
     def test_add_two_numbers_no_input(
-            self,
-            number_left: int,
-            number_right: int
+        self, number_left: int, number_right: int
     ) -> None:
         """Basic input validation."""
         with pytest.raises(ValueError):