Architecture
This library broadly is separated into three key functional areas:
Parser: Downstream tools may provide concrete implementation of the
cyclonedx.parser.BaseParser
which can easily help you build a Model from your project or ecosystem. For Python specific parser implementations see cyclonedx-pythonModel: Internal models used to unify data from different parsers
Note: As of version 4.0.0 of this library we support deserialization from JSON and XML as well as serialization to JSON and XML.
Output: Choose and configure an output which allows you to define output format as well as the CycloneDX schema version
When wishing to generate a BOM, the process is as follows:
- Generate a Model by either:
Programmatically using this library
By deserializing from an existing CycloneDX BOM document
From a
cyclonedx.parser
Output the Model using an
cyclonedx.output
instance that reflects the schema version and format you require