|
15 | 15 | CycloneDX’s Python Library documentation
|
16 | 16 | ====================================================
|
17 | 17 |
|
18 |
| -CycloneDX is a lightweight BOM specification that is easily created, human-readable, and simple to parse. |
| 18 | +OWASP `CycloneDX`_ is a full-stack Bill of Materials (BOM) standard |
| 19 | +that provides advanced supply chain capabilities for cyber risk reduction. |
19 | 20 |
|
20 |
| -This CycloneDX module for Python can generate valid CycloneDX bill-of-material document containing an aggregate of all |
21 |
| -project dependencies. |
| 21 | +This Python package provides data models, validators and more, |
| 22 | +to help you create/render/read CycloneDX documents. |
22 | 23 |
|
23 |
| -As of version ``3.0.0``, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per |
24 |
| -`official examples`_ linking VEX to a separate BOM. |
| 24 | +**This package is not designed for standalone use. It is a software library.** |
25 | 25 |
|
26 |
| -This module is not designed for standalone use (i.e. it is not executable on it’s own). If you’re looking for a |
27 |
| -CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout: |
| 26 | +As of version ``3.0.0`` of this library, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per |
| 27 | +`official examples`_ linking VEX to a separate CycloneDX document. |
28 | 28 |
|
29 |
| -* `CycloneDX Python`_ |
30 |
| -* `Jake`_ |
31 |
| -* `CycloneDX Tool Center`_ |
32 |
| - |
33 |
| -This library was designed to be used by developers - you can use this module yourself in your application to |
34 |
| -programmatically generate SBOMs. |
| 29 | +If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout |
| 30 | +`CycloneDX Python`_ or `Jake`_. |
35 | 31 |
|
36 | 32 |
|
| 33 | +.. _CycloneDX: https://cyclonedx.org/ |
| 34 | +.. _official examples: https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory |
37 | 35 | .. _CycloneDX Python: https://pypi.org/project/cyclonedx-bom/
|
38 | 36 | .. _Jake: https://pypi.org/project/jake
|
39 | 37 | .. _CycloneDX Tool Center: https://cyclonedx.org/tool-center/
|
40 |
| -.. _official examples: https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory |
41 | 38 |
|
42 | 39 |
|
43 | 40 | .. toctree::
|
|
0 commit comments