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.

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-3.0.0rc0.tar.gz (160.0 kB view details)

Uploaded Source

Built Distribution

cyclonedx_python_lib-3.0.0rc0-py3-none-any.whl (198.0 kB view details)

Uploaded Python 3

File details

Details for the file cyclonedx-python-lib-3.0.0rc0.tar.gz.

File metadata

File hashes

Hashes for cyclonedx-python-lib-3.0.0rc0.tar.gz
Algorithm Hash digest
SHA256 6d7b82f1435ee7c7337d2f8730dea7a43f9c3d65f0eb7c30741533c6c824c8ec
MD5 e867ca6ea70c5de87c02b426f4faa454
BLAKE2b-256 2804e390e2dc1aa1df8ad8ce5da7dd1f84157d2f338e58571b747b27c1cd0a43

See more details on using hashes here.

Provenance

File details

Details for the file cyclonedx_python_lib-3.0.0rc0-py3-none-any.whl.

File metadata

File hashes

Hashes for cyclonedx_python_lib-3.0.0rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 2c3c991377aedb5cce24609dd15e828b442eee7e5c11e3cb4db6adbfd9fdab0f
MD5 c833431f2294a072617765cb14d389f1
BLAKE2b-256 a87986eb2f67d4a3817f0906abed8a2fb2587a6af0d063bc56f02ad934e4bf38

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