Skip to main content

CycloneDX software bill-of-material (SBOM) generation utility

Project description

Build Status License Website PyPI Group Discussion Twitter

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.txt

Installing

$ pip install cyclonedx-bom

Options

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

License

Permission to modify and redistribute is granted under the terms of the Apache 2.0 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-bom-0.3.3.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

cyclonedx_bom-0.3.3-py2.py3-none-any.whl (20.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file cyclonedx-bom-0.3.3.tar.gz.

File metadata

  • Download URL: cyclonedx-bom-0.3.3.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.22.0 setuptools/18.5 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.10

File hashes

Hashes for cyclonedx-bom-0.3.3.tar.gz
Algorithm Hash digest
SHA256 af6b5df43d3de2a1535354ea2366e4cec573afe8b2fdd8c05caa1ca6a40fc8b0
MD5 4a395584509de41089aa03a6ea75dd11
BLAKE2b-256 41b09ca187386c5a2a87ab84cf52a39f40cc367c6176150ee771df59a5d4c661

See more details on using hashes here.

Provenance

File details

Details for the file cyclonedx_bom-0.3.3-py2.py3-none-any.whl.

File metadata

  • Download URL: cyclonedx_bom-0.3.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.22.0 setuptools/18.5 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.10

File hashes

Hashes for cyclonedx_bom-0.3.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0cba8227922d013efe224b93e35579d92f60299428b310df0fee97eab72e47be
MD5 4811d6f304ccebccea76d6276acd431f
BLAKE2b-256 479de37d6981c8a08337dc897990a2be6c63023e6bce0898c2ceec3b4fa58185

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