Skip to content

docs: fix code examples regarding outputting #709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2024
Merged

docs: fix code examples regarding outputting #709

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions docs/outputting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,18 @@ as a ``str``.

.. code-block:: python

from cyclonedx.output import get_instance, BaseOutput, OutputFormat
from cyclonedx.output import make_outputter, BaseOutput, OutputFormat, SchemaVersion

outputter: BaseOutput = get_instance(bom=bom, output_format=OutputFormat.JSON)
outputter: BaseOutput = make_outputter(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_6)
bom_json: str = outputter.output_as_string()

Alternatively, if the output format and schema version are constants, you can use the predefined format+schema combined outputs:

.. code-block:: python

from cyclonedx.output.json import JsonV1Dot6

outputter = JsonV1Dot6(bom=bom)
bom_json: str = outputter.output_as_string()


Expand All @@ -58,7 +67,16 @@ written to the supplied filename.

.. code-block:: python

from cyclonedx.output import get_instance, BaseOutput, SchemaVersion
from cyclonedx.output import make_outputter, BaseOutput, OutputFormat, SchemaVersion

outputter: BaseOutput = make_outputter(bom=bom, output_format=OutputFormat.XML, schema_version=SchemaVersion.V1_2)
outputter.output_to_file(filename='/tmp/sbom-v1.2.xml')

Alternatively, if the output format and schema version are constants, you can use the predefined format+schema combined outputs:

.. code-block:: python

from cyclonedx.output.xml import XmlV1Dot2

outputter: BaseOutput = get_instance(bom=bom, schema_version=SchemaVersion.V1_2)
outputter.output_to_file(filename='/tmp/sbom-v1.2.xml')
outputter = XmlV1Dot2(bom=bom)
outputter.output_to_file(filename='/tmp/sbom-v1.2.xml')