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

Uploaded Source

Built Distribution

cyclonedx_python_lib-3.0.0rc1-py3-none-any.whl (198.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for cyclonedx-python-lib-3.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 61622a8cf82b7e525f333be8bde9cd48939e694ce0c9b9e238b233d7e3eebe28
MD5 8185c444aee32afba2b4d1c0cdfa1beb
BLAKE2b-256 9302e360948af4aa4841389557796f6a74e3b23d522a0482b3ec31e1b49a9caf

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cyclonedx_python_lib-3.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 7c2aac40b7efed075136b8f9cd1c91aa6920225e97159fed1b2672acf886b55e
MD5 a2043136c47880d99daac3f44ce4f40a
BLAKE2b-256 59f171af40b4b974791638d80fbb56d1952cd76ec6fe04cc758622250271a997

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