Skip to content

Commit

Permalink
feat: support CycloneDX 1.6 output (#720)
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
  • Loading branch information
jkowalleck authored Apr 18, 2024
1 parent b51be59 commit 639b35a
Show file tree
Hide file tree
Showing 175 changed files with 93,487 additions and 15 deletions.
13 changes: 7 additions & 6 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ The full documentation can be issued by running with ``--help``:
-h, --help show this help message and exit
--version show program's version number and exit
Example usage: save SBOM in CycloneDX 1.5 XML format, generated from current python environment
Example usage: save SBOM in CycloneDX 1.6 XML format, generated from current python environment

.. code-block:: shell
cyclonedx-py environment --outfile my-sbom.xml --schema-version 1.5 --output-format XML
cyclonedx-py environment --outfile my-sbom.xml --schema-version 1.6 --output-format XML
For Python (virtual) environment
Expand Down Expand Up @@ -78,7 +78,7 @@ The full documentation can be issued by running with ``environment --help``:
(default: -)
--sv <version>, --schema-version <version>
The CycloneDX schema version for your SBOM
{choices: 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
{choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
(default: 1.5)
--of <format>, --output-format <format>
The output format for your SBOM
Expand Down Expand Up @@ -238,7 +238,7 @@ The full documentation can be issued by running with ``pipenv --help``:
(default: -)
--sv <version>, --schema-version <version>
The CycloneDX schema version for your SBOM
{choices: 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
{choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
(default: 1.5)
--of <format>, --output-format <format>
The output format for your SBOM
Expand Down Expand Up @@ -313,7 +313,8 @@ The full documentation can be issued by running with ``poetry --help``:
(default: -)
--sv <version>, --schema-version <version>
The CycloneDX schema version for your SBOM
{choices: 1.5, 1.4, 1.3, 1.2, 1.1, 1.0} (default: 1.5)
{choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
(default: 1.5)
--of <format>, --output-format <format>
The output format for your SBOM
{choices: JSON, XML}
Expand Down Expand Up @@ -383,7 +384,7 @@ The full documentation can be issued by running with ``requirements --help``:
(default: -)
--sv <version>, --schema-version <version>
The CycloneDX schema version for your SBOM
{choices: 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
{choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
(default: 1.5)
--of <format>, --output-format <format>
The output format for your SBOM
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,10 @@ cyclonedx-py = "cyclonedx_py._internal.cli:run"

[tool.poetry.dependencies]
python = "^3.8"
cyclonedx-python-lib = { version = "^6.1.0", extras = ["validation"] }
cyclonedx-python-lib = { version = "^7.0.0", extras = ["validation"] }
packageurl-python = ">=0.11, <2" # keep in sync with same dep in `cyclonedx-python-lib`
pip-requirements-parser = "^32.0"
packaging = "^22||^23 || ^24"
packaging = "^22 || ^23 || ^24"
tomli = { version = "^2.0.1", python = "<3.11" }
chardet = "^5.1"

Expand Down
64 changes: 64 additions & 0 deletions tests/_data/snapshots/environment/plain_editable-self_1.6.json.bin

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

77 changes: 77 additions & 0 deletions tests/_data/snapshots/environment/plain_editable-self_1.6.xml.bin

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

122 changes: 122 additions & 0 deletions tests/_data/snapshots/environment/plain_local_1.6.json.bin

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 639b35a

Please sign in to comment.