chore: make isort and flake8-isort available

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

.isort.cfg

@@ -0,0 +1,17 @@
+[settings]
+## read the docs: https://pycqa.github.io/isort/docs/configuration/options.html
+## keep in sync with flake8 config - in `tox.ini` file
+known_first_party = cyclonedx
+skip_gitignore = true
+skip_glob =
+    build/*,dist/*,__pycache__,.eggs,*.egg-info*,
+    *_cache,*.cache,
+    .git/*,.tox/*,.venv/*,venv/*
+    _OLD/*,_TEST/*,
+    docs/*
+combine_as_imports = true
+default_section = THIRDPARTY
+ensure_newline_before_comments = true
+include_trailing_comma = true
+line_length = 120
+multi_line_output = 3

CONTRIBUTING.md

@@ -18,14 +18,18 @@ poetry install
 ## Code style
 
 This project uses [PEP8] Style Guide for Python Code.  
-Get it applied via:
+This project loves sorted imports.  
+Get it all applied via:
 
 ```shell
+poetry run isort .
 poetry run autopep8 --in-place -r .
 ```
 
 ## Testing
 
+Run all tests in dedicated environments, via:
+
 ```shell
 poetry run tox
 ```

poetry.lock

@@ -59,9 +59,11 @@ tox = "^3.24.3"
 coverage = "^6.2"
 mypy = ">= 0.920, < 1.00"
 autopep8 = "^1.6.0"
+isort = { version = "^5.10.0", python = ">= 3.6.1" }
 flake8 = "^4.0.1"
 flake8-annotations = {version = "^2.7.0", python = ">= 3.6.2"}
 flake8-bugbear = "^22.1.11"
+flake8-isort = { version = "^4.1.0", python = ">= 3.6.1" }
 jsonschema = { version = ">= 4.4.0", python = "> 3.6"}
 lxml = ">=4.7.0"
 xmldiff = ">=2.4"

pyproject.toml

@@ -41,8 +41,10 @@ commands =
     poetry run flake8 cyclonedx/ tests/
 
 [flake8]
+## keep in sync with isort config - in `isort.cfg` file
 exclude =
-    build,dist,__pycache__,.eggs,*_cache
+    build,dist,__pycache__,.eggs,*.egg-info*,
+    *_cache,*.cache,
     .git,.tox,.venv,venv
     _OLD,_TEST,
     docs