CycloneDX software bill-of-material (SBOM) generation utility
Project description
CycloneDX Python Module
The CycloneDX module for Python creates a 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.
Usage
Freezing
A bill-of-material such as CycloneDX expects exact version numbers. Therefore requirements.txt must be frozen. This can be accomplished via:
$ pip freeze > requirements.txtInstalling
$ pip install cyclonedx-bomOptions
By default, requirements.txt will be read from the current working directory and the resulting bom.xml will also be created in the current working directory. These options can be overwritten as follows:
$ cyclonedx-py
Usage: cyclonedx-py [OPTIONS]
Options:
-i <path> - the alternate filename to a frozen requirements.txt
-o <path> - the bom file to create
-j - generate JSON instead of XMLLicense
Permission to modify and redistribute is granted under the terms of the Apache 2.0 license.
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
Built Distribution
File details
Details for the file cyclonedx-bom-0.4.2.tar.gz.
File metadata
- Download URL: cyclonedx-bom-0.4.2.tar.gz
- Upload date:
- Size: 24.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.1 CPython/3.5.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5ea3c716ba19793c2ace35ccd343a668a92b1b9f242bcbdf9b311b211e1ee048 |
|
| MD5 | 56229c36840a3832bf41e98a2ee00d42 |
|
| BLAKE2b-256 | 1f0f4583423a60aa2fcc60d225a70476f7a959d63e2a4c8026cc58c8bdd47db2 |
Provenance
File details
Details for the file cyclonedx_bom-0.4.2-py2.py3-none-any.whl.
File metadata
- Download URL: cyclonedx_bom-0.4.2-py2.py3-none-any.whl
- Upload date:
- Size: 32.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.1 CPython/3.5.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f9b6e36d61455197e3c369fd613c4b76eb94da0f139e86a3dc517fc47e1cbb42 |
|
| MD5 | 257d5ce5777145e16a29b2fd3ad52ea8 |
|
| BLAKE2b-256 | e4c2fc2c184297e1a184aa39b70e503b88e1d3a670eeac6194b6f695f2520336 |
