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

Uploaded Source

Built Distribution

cyclonedx_python_lib-4.0.0rc1-py3-none-any.whl (196.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for cyclonedx_python_lib-4.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 fe13a7d597c454fa6df85f4821160e43225b7aa93522b3f3a7ea8465eb469e2c
MD5 2def570b945b897ae97ada7a4d8dffab
BLAKE2b-256 da654876424701bfa4ed084f46a3dd747b219e77d507aa9e7b6572a3b07a1757

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cyclonedx_python_lib-4.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 ca36ffb3008217c010e2a0ee51afb1b9983e8c38cc0af2125272a65df217f3a6
MD5 2df8009abf251b0f3d1f7d46a1e4c2c4
BLAKE2b-256 c6f9d655611efa92227efb41daf6d6fa175ed04ae0f6ab01d31a99e82235beab

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