Architecture

This library broadly is separated into three key functional areas:

1. 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-python

2. Model: Internal models used to unify data from different parsers

3. 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:

1. Generated a Model (either programmatically or from a cyclonedx.parser

2. Output the Model using an cyclonedx.output instance that reflects the schema version and format you require

Contents:

• Modelling
  • Example BOM using a Parser
  • Example BOM created programmatically
• Schema Support
• Outputting
  • Supported CycloneDX Schema Versions
  • Outputting to JSON
  • Outputting to XML