Merge branch 'CWG-11-auto-format-linting' into 'main'

CWG-11: linting auto format and appropriate documentation

Closes CWG-11

See merge request templates/python-package!6

README.md

@@ -22,7 +22,22 @@ cool_module.greeter()   # prints "Hello World"
 ## Contributing
 
 To contribute, please create a feature branch and a "Draft" merge request.
-Upon completion, the merge request should be marked as ready and a reviewer should be assigned.
+Upon completion, the merge request should be marked as ready and a reviewer
+should be assigned.
+
+Verify your changes locally and be sure to add tests. Verifying local
+changes is done through `tox`.
+
+```pip install tox```
+
+With tox the same jobs as run on the CI/CD pipeline can be ran. These
+include unit tests and linting.
+
+```tox```
+
+To automatically apply most suggested linting changes execute:
+
+```tox -e format```
 
 ## License
 This project is licensed under the Apache License Version 2.0

tests/requirements.txt

 black
 build
 flake8
+autopep8 >= 1.7.0 # MIT
 pylint
 pytest
 pytest-cov

tox.ini

@@ -25,7 +25,7 @@ commands =
 
 # Use generative name and command prefixes to reuse the same virtualenv
 # for all linting jobs.
-[testenv:{pep8,black,pylint}]
+[testenv:{pep8,black,pylint,format}]
 usedevelop = False
 envdir = {toxworkdir}/linting
 commands =
@@ -35,6 +35,10 @@ commands =
     black: {envpython} -m black --check --diff .
     pylint: {envpython} -m pylint --version
     pylint: {envpython} -m pylint map tests
+    format: {envpython} -m autopep8 -v -aa --in-place --recursive map
+    format: {envpython} -m autopep8 -v -aa --in-place --recursive tests
+    format: {envpython} -m black -v .
+
 
 [testenv:build]
 usedevelop = False