Skip to main content

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

Project description

CycloneDX Python Library

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cyclonedx_python_lib-5.0.0.tar.gz
  • Upload date:
  • Size: 431.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for cyclonedx_python_lib-5.0.0.tar.gz
Algorithm Hash digest
SHA256 46cdad7308a10cbad078e025ceb6ab9b27fa929d28cd7981f82a47653911b4aa
MD5 10c011717274589c77a05d3da3a4b17e
BLAKE2b-256 543156769a3fa6c5e9b98093f029f08dcce7e55597a175e1e3a76bb61707969f

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cyclonedx_python_lib-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58977088814c3defa9480c52352468986eae4330cb7cf879f29513010075763d
MD5 5c4c26151ea161d77ac09f1607447267
BLAKE2b-256 4069be710bdabe39985eae46349f385d8ba03aa61b454d1a3b586d85cd5942d8

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