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

This version

0.3.5

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

Uploaded Source

Built Distribution

cyclonedx_bom-0.3.5-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.5.tar.gz.

File metadata

  • Download URL: cyclonedx-bom-0.3.5.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.16

File hashes

Hashes for cyclonedx-bom-0.3.5.tar.gz
Algorithm Hash digest
SHA256 4a72c64e211fd1450c81292baa3a8dc4696b5a7b0f2a453e733bea0e3073efb7
MD5 72931cfb701e85beecaaa33c9e531457
BLAKE2b-256 70fc0a4cfb6725e227ecb625dc57c72b9c9da856ad9958fbbab74af741d99679

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: cyclonedx_bom-0.3.5-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.16

File hashes

Hashes for cyclonedx_bom-0.3.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 99ba2ec3603083131ab3a64b64d24dd6bd527815c99e34881d3844875858bd7e
MD5 b68c70037ecc32da5c297db97c5756ac
BLAKE2b-256 caea281f0d487a290075c2519489bd48f94f564580c22e4452d68b5e7c9772f9

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