Metadata-Version: 2.1
Name: hoppr-cyclonedx-models
Version: 0.2.0
Summary: CycloneDX Pydantic models for easy use in your Python project.
Home-page: https://gitlab.com/lmco/hoppr/hoppr-cyclonedx-models
License: MIT
Keywords: pydantic models,cyclonedx,software bill of materials
Author: LMCO Open Source
Author-email: open.source@lmco.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Code Generators
Requires-Dist: datamodel-code-generator (>=0.13.0,<0.14.0)
Requires-Dist: pydantic (>=1.9.1,<2.0.0)
Requires-Dist: pylint (>=2.14.4,<3.0.0)
Requires-Dist: semantic-release (>=0.1.0,<0.2.0)
Project-URL: Repository, https://gitlab.com/lmco/hoppr/hoppr-cyclonedx-models
Description-Content-Type: text/markdown

# hoppr_cyclonedx_models

## Purpose
The `model-gen.sh` script pulls a user-specified release from the [CycloneDX SBOM Specification](https://github.com/CycloneDX) that operates under the SBOM guidelines.  It then utilizes the [datamodel code generator](https://koxudaxi.github.io/datamodel-code-generator/) to generate Pydantic models from the input SBOM schema file.  These Pydantic models are available as a public package in PyPI under `hoppr_cyclonedx_models`.
## Usage 
### Install `datamodel-code-generator`:
-----------------------------------------
`pip install datamodel-code-generator`

For further reference see the [documentation](https://koxudaxi.github.io/datamodel-code-generator/).

### Create your model:
-----------------------------------------
`./model-gen.sh x.y` 

Where x and y refer to the applicable major and minor revisons respectively.

* Example Usage: `./model-gen.sh 1.4`

To see all current releases visit [CycloneDX Specification Releases](https://github.com/CycloneDX/specification/releases)
