Metadata-Version: 2.1
Name: cyclonedx-bom
Version: 0.3.3
Summary: CycloneDX software bill-of-material (SBOM) generation utility
Home-page: https://github.com/CycloneDX/cyclonedx-python
Author: Steve Springett
Author-email: steve.springett@owasp.org
License: Apache-2.0
Keywords: BOM,SBOM,SCA
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Legal Industry
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Security
Classifier: Topic :: Software Development
Classifier: Topic :: System :: Software Distribution
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: requirements-parser (==0.1.0)
Requires-Dist: packageurl-python (==0.8.7)
Requires-Dist: xmlschema (==1.0.14)
Requires-Dist: requests (==2.22.0)
Requires-Dist: packaging (==19.1)

.. image:: https://github.com/CycloneDX/cyclonedx-python/workflows/Python%20CI/badge.svg
   :alt: Build Status
   :target: https://github.com/CycloneDX/cyclonedx-python/actions?workflow=Python+CI

.. image:: https://img.shields.io/badge/license-Apache%202.0-brightgreen
   :alt: License
   :target: https://github.com/CycloneDX/cyclonedx-python/blob/master/LICENSE

.. image:: https://img.shields.io/badge/https://-cyclonedx.org-blue
   :alt: Website
   :target: https://cyclonedx.org/

.. image:: https://img.shields.io/pypi/v/cyclonedx-bom
   :alt: PyPI
   :target: https://pypi.org/project/cyclonedx-bom/

.. image:: https://img.shields.io/badge/discussion-groups.io-blue
   :alt: Group Discussion
   :target: https://groups.io/g/CycloneDX

.. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Follow
   :alt: Twitter
   :target: https://twitter.com/CycloneDX_Spec

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:

.. code-block:: console

    $ pip freeze > requirements.txt


**Installing**

.. code-block:: console

    $ 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:

.. code-block:: console

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


