Skip to main content

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

Project description

CycloneDX Python Library

shield_pypi-version shield_conda-forge-version shield_rtfd shield_gh-workflow-test shield_coverage 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.

Changelog

See our CHANGELOG.

Contributing

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.

Project details


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-5.0.0rc2.tar.gz (431.2 kB view details)

Uploaded Source

Built Distribution

cyclonedx_python_lib-5.0.0rc2-py3-none-any.whl (186.7 kB view details)

Uploaded Python 3

File details

Details for the file cyclonedx_python_lib-5.0.0rc2.tar.gz.

File metadata

File hashes

Hashes for cyclonedx_python_lib-5.0.0rc2.tar.gz
Algorithm Hash digest
SHA256 596390f2414eaf2a088d0c883d27ffd78c7b7ef8576249840021c54595134793
MD5 be46d9f53233720cc0199a5dce80e730
BLAKE2b-256 e46be7a97e629ff6167ec68cabf691d364f2b42a080697afd1f6001c4ea65875

See more details on using hashes here.

Provenance

File details

Details for the file cyclonedx_python_lib-5.0.0rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for cyclonedx_python_lib-5.0.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 47af40088a70599e135904f0f307d1e84a718127ca88b0ee78dff696c7104cfd
MD5 8bd517cbc60f6ccf7b23b18dbe538146
BLAKE2b-256 e5c76a0a4f4b9ca53588719830d43926e5ecd8b2c2e65f946ae3a400c7d54bb3

See more details on using hashes here.

Provenance

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