docs: improve example for programmatic call of CLI (#670)

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Author: jkowalleck

README.md

@@ -102,12 +102,7 @@ However, there are older versions of this tool, that support `python>=2.7`.
 This tool utilizes the [CycloneDX Python library][cyclonedx-library] to generate the actual data structures, and serialize and validate them.  
 
 This tool does **not** expose any additional _public_ API or symbols - all code is intended to be internal and might change without any notice during version upgrades.
-However, the CLI is stable - you might call it programmatically, like so:
-```python
-from sys import executable
-from subprocess import run
-run((executable, '-m', 'cyclonedx_py', '--help'))
-```
+However, the CLI is stable - you might call it programmatically. See the documentation for an example.
 
 ## Contributing
 

cyclonedx_py/__init__.py

@@ -13,13 +13,12 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright (c) OWASP Foundation. All Rights Reserved.
 
-# !! version is managed by semantic_release
+# !! version is managed by `semantic_release`
 # do not use typing here, or else `semantic_release` might have issues finding the variable
-# flake8: noqa
-__version__ = "4.1.0"
+__version__ = "4.1.0"  # noqa:Q000
 
 # There is no stable/public API.
-# You might use this instead:
+# However, you might call the stable CLI instead, like so:
 #   from sys import executable
 #   from subprocess import run
 #   run((executable, '-m', 'cyclonedx_py', '--help'))

cyclonedx_py/__main__.py

@@ -15,7 +15,7 @@
 
 __all__ = [  # type:ignore[var-annotated]
     # There is no stable/public API.
-    # You might use this instead:
+    # However, you might call the stable CLI instead, like so:
     #   from sys import executable
     #   from subprocess import run
     #   run((executable, '-m', 'cyclonedx_py', '--help'))