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

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for coderpatros from gravatar.com coderpatros Avatar for CycloneDX from gravatar.com CycloneDX Avatar for jkowalleck from gravatar.com jkowalleck Avatar for madpah from gravatar.com madpah Avatar for sspringett from gravatar.com sspringett

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache-2.0)
  • Author: Steve Springett
  • Tags BOM, SBOM, SCA
Classifiers

Project description

Build Status Docker Image License Website Slack Invite 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
    -j        - generate JSON instead of XML

License

Permission to modify and redistribute is granted under the terms of the Apache 2.0 license.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for coderpatros from gravatar.com coderpatros Avatar for CycloneDX from gravatar.com CycloneDX Avatar for jkowalleck from gravatar.com jkowalleck Avatar for madpah from gravatar.com madpah Avatar for sspringett from gravatar.com sspringett

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache-2.0)
  • Author: Steve Springett
  • Tags BOM, SBOM, SCA
Classifiers

Release history Release notifications | RSS feed

5.1.1

5.1.0

5.0.0

4.6.1

4.6.1a1 pre-release

4.6.0

4.5.1

4.5.0

4.4.3

4.4.2

4.4.1

4.4.0

4.3.4a1 pre-release

4.3.3a1 pre-release

4.3.2a1 pre-release

4.3.1a1 pre-release

4.3.0

4.2.0

4.1.6

4.1.5

4.1.4

4.1.3

4.1.2

4.1.1

4.1.0

4.0.0

4.0.0rc6 pre-release

4.0.0rc5 pre-release

4.0.0rc4 pre-release

4.0.0rc2 pre-release

4.0.0rc1 pre-release

3.11.7

3.11.6

3.11.5

3.11.4

3.11.3

3.11.2

3.11.1

3.11.0

3.10.1

3.10.0

3.9.0

3.8.0

3.7.4

3.7.3

3.7.2

3.7.1

3.7.0

3.6.4

3.6.3

3.6.2

3.6.1

3.6.0

3.5.0

3.4.0

3.3.0

3.2.2

3.2.1

3.2.0

3.1.1

3.1.0

3.0.0

3.0.0rc3 pre-release

3.0.0rc2 pre-release

3.0.0rc1 pre-release

3.0.0rc0 pre-release

2.1.0 yanked

Reason this release was yanked:

Should have been 3.0.0

2.0.3

2.0.2

2.0.1

2.0.0

2.0.0rc1 pre-release

2.0.0rc0 pre-release

1.5.3

1.5.2

1.5.1

1.5.0

1.4.3

1.4.2

1.4.1

1.4.0

1.3.1

1.3.0

1.2.0

1.1.0

1.0.5

1.0.4

1.0.3

1.0.2

0.4.3

0.4.2

0.4.1

This version

0.4.0

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.0

0.1.0

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

Uploaded Source

Built Distribution

cyclonedx_bom-0.4.0-py2.py3-none-any.whl (32.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: cyclonedx-bom-0.4.0.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/18.5 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.5.9

File hashes

Hashes for cyclonedx-bom-0.4.0.tar.gz
Algorithm Hash digest
SHA256 6bd96a906b263a987eb0ae485264e87002c5645dab1b03ed027e13cd8c3f4591
MD5 c83198492c2b1aac29d39e7aea7f01c2
BLAKE2b-256 c321a4d86c0f110217d005bde5d044aaaa0a4189f4d28fbc2f0e7b22bfb71dd7

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: cyclonedx_bom-0.4.0-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.22.0 setuptools/18.5 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.5.9

File hashes

Hashes for cyclonedx_bom-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9e1f1b9a9fe8dc338652f02b5da07e01e36768fe1e9a7f2b63b90e444f0af18a
MD5 bce3441ef5c8f0e366bbb839c37fd889
BLAKE2b-256 73aa72a84653f1f27ae3eabe6e9717dda80953eda7b2b1da28e84ab46639bcf4

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