Skip to main content

A library for producing CycloneDX SBOM (Software Bill of Materials) files.

Project description

Python Library for generating CycloneDX

shield_gh-workflow-test shield_rtfd shield_pypi-version shield_conda-forge-version shield_license
shield_website shield_slack shield_groups shield_twitter-follow

This CycloneDX module for Python can generate valid CycloneDX bill-of-material document containing an aggregate of all project dependencies. CycloneDX is a lightweight BOM specification that is easily created, human-readable, and simple to parse.

This module is not designed for standalone use.

As of version 3.0.0, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per official examples linking a VEX documents to a separate BOM document.

If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout CycloneDX Python or Jake.

Alternatively, you can use this module yourself in your application to programmatically generate CycloneDX BOMs.

View the documentation here.

Python Support

We endeavour to support all functionality for all current actively supported Python versions. However, some features may not be possible/present in older Python versions due to their lack of support.




Feel free to open issues, bugreports or pull requests.
See the CONTRIBUTING file for details.

Copyright & License

CycloneDX Python Lib is Copyright (c) OWASP Foundation. All Rights Reserved.
Permission to modify and redistribute is granted under the terms of the Apache 2.0 license.
See the LICENSE file for the full license.

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cyclonedx_python_lib-4.0.0.tar.gz (246.2 kB view hashes)

Uploaded source

Built Distribution

cyclonedx_python_lib-4.0.0-py3-none-any.whl (196.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page