Skip to main content

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

Project description

Python Library for generating CycloneDX

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.0rc1.tar.gz (431.8 kB view details)

Uploaded Source

Built Distribution

cyclonedx_python_lib-5.0.0rc1-py3-none-any.whl (186.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for cyclonedx_python_lib-5.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 b830d71c8053192c82b019f2845acae902fc43c132bd9b59986500638fa94d48
MD5 9bb369b9c09a1d5fd64d6b1a2f3c0225
BLAKE2b-256 fa249f60359ffe97aa248b13ca84a2f0d0863a6c8528bd1ad77280d97c6777be

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cyclonedx_python_lib-5.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 4859e0726567aaf93d94d9d625a4886bf5bc7566ceb83be4ecf30e123381395d
MD5 6e625fd949f133144fc0f7becd084b42
BLAKE2b-256 50fccf8370a6a3e87c4f9a86484bc2a0a668eb1cd385fc9866cd569960bdc449

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