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

Uploaded Source

Built Distribution

cyclonedx_python_lib-4.0.0rc0-py3-none-any.whl (196.6 kB view details)

Uploaded Python 3

File details

Details for the file cyclonedx_python_lib-4.0.0rc0.tar.gz.

File metadata

File hashes

Hashes for cyclonedx_python_lib-4.0.0rc0.tar.gz
Algorithm Hash digest
SHA256 d521c5d531c53b3da52290b16dfc210a38298d41132043faa9741096b471a6a7
MD5 c7ed3ffcf0c210224160e172c5fcd1d2
BLAKE2b-256 7340d7b183c2a9dd17a4c84f86fe509737d547c6b7dcec4a990541f0ba0a4cbb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cyclonedx_python_lib-4.0.0rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 cfc8f7eb589472e7cf02094d43f621f915a1ef5e5c34288ba4243f45dd804e19
MD5 d857961b40b62b218c29bb4c0068ab49
BLAKE2b-256 bdae19bf932b74a56de71a1433315196ddaeacf1b4bce1748cf91dd6e35725e6

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