CycloneDX Software Bill of Materials (SBOM) generator for Python projects and environments
Project description
CycloneDX Python SBOM Generation Tool
This tool generates Software Bill of material (SBOM) documents in OWASP CycloneDX format.
Supported data sources are:
- Python (virtual) environment
Poetrymanifest and lockfilePipenvmanifest and lockfile- Pip's
requirements.txtformat PDMmanifest and lockfile are not explicitly supported.
However, PDM's Python virtual environments are fully supported. See the docs for an example.Condaas a package manager is no longer supported since version 4.
However, conda's Python environments are fully supported via the methods listed above. See the docs for an example.
Based on OWASP Software Component Verification Standard for Software Bill of Materials' criteria, this tool is capable of producing SBOM documents almost passing Level-2 (only signing needs to be done externally).
The resulting SBOM documents follow official specifications and standards,
and might have properties following
cdx:python Namespace Taxonomy,
cdx:pipenv Namespace Taxonomy,
cdx:poetry Namespace Taxonomy
.
Read the full documentation for more details.
Requirements
- Python
>=3.8,<4
However, there are older versions of this tool available, which
support Python >=2.7.
Installation
Install this from Python Package Index (PyPI) using your preferred Python package manager.
install via one of commands:
python -m pip install cyclonedx-bom # install via pip
pipx install cyclonedx-bom # install via pipx
poetry add cyclonedx-bom # install via poetry
# ... you get the hang
Usage
Call via one of commands:
cyclonedx-py # call script
python3 -m cyclonedx_py # call python module CLI
Basic usage
$ cyclonedx-py --help
usage: cyclonedx-py [-h] [--version] command ...
Creates CycloneDX Software Bill of Materials (SBOM) from Python projects and environments.
positional arguments:
command
environment Build an SBOM from Python (virtual) environment
requirements Build an SBOM from Pip requirements
pipenv Build an SBOM from Pipenv manifest
poetry Build an SBOM from Poetry project
options:
-h, --help show this help message and exit
--version show program's version number and exit
Advanced usage and details
See the full documentation for advanced usage and details on input formats, switches and options.
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.
However, there are older versions of this tool, that support python>=2.7.
Internals
This tool utilizes the CycloneDX Python library to generate the actual data structures, and serialize and validate them.
This tool does not expose any additional public API or symbols - all code is intended to be internal and might change without any notice during version upgrades. However, the CLI is stable - you might call it programmatically. See the documentation for an example.
Contributing
Feel free to open issues, bugreports or pull requests.
See the CONTRIBUTING file for details.
Copyright & License
CycloneDX BOM 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.
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-4.5.1.tar.gz.
File metadata
- Download URL: cyclonedx_bom-4.5.1.tar.gz
- Upload date:
- Size: 2.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d4db99b61ac7a7bf3d0621c9188227412406206529c32c6d463caf97424f020f |
|
| MD5 | 8e0cd4bdea63f528c9b165967860d79d |
|
| BLAKE2b-256 | 928feeff1e00cc2bca1091d2a92c0d75bb9b4f3bb235f862d4c748513a88b809 |
Provenance
File details
Details for the file cyclonedx_bom-4.5.1-py3-none-any.whl.
File metadata
- Download URL: cyclonedx_bom-4.5.1-py3-none-any.whl
- Upload date:
- Size: 54.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | df1ae65873fa7b5c2ce3292a6f002356dfb4589154972a55dfd895a6715a8445 |
|
| MD5 | 6e527863fa00f7465ebc03ba3384f52e |
|
| BLAKE2b-256 | 83801d043b3a32bf8fca2d85ab4f4f10d7c2dd0a9ed74a1695b255680567d218 |
