# Hoppr CycloneDX Models
[](https://pypi.org/project/hoppr-cyclonedx-models)
[](https://pypi.org/project/hoppr-cyclonedx-models)
[](LICENSE)
[](https://python-poetry.org/)
Serializable CycloneDX Models. Quickly get up and running with models generated directly off the specification.
Current generated models can be found [here](hoppr_cyclonedx_models).
## Installation
Install using `pip install --upgrade hoppr-cyclonedx-models` or `poetry add hoppr-cyclonedx-models`.
## A Simple Example
```python
>>> from hoppr_cyclonedx_models.cyclonedx_1_5 import Component
>>> data = {"type": "library", "purl": "pkg:pypi/django@1.11.1", "name": "django", "version": "1.11.1"}
>>> component = Component(**data)
>>> component
>>> print(component)
Component(
type='library',
mime_type=None,
bom_ref=None,
supplier=None,
author=None,
publisher=None,
group=None,
name='django',
version='1.11.1',
description=None,
scope=<Scope.REQUIRED: 'required'>,
hashes=None,
licenses=None,
copyright=None,
cpe=None,
purl='pkg:pypi/django@1.11.1',
swid=None,
modified=None,
pedigree=None,
externalReferences=None,
components=None,
evidence=None,
releaseNotes=None,
modelCard=None,
data=None,
properties=None,
signature=None
)
```
## Contributing
For guidance setting up a development environment and how to contribute to `hoppr-cyclonedx-models`,
see [Contributing to Hoppr](https://hoppr.dev/docs/development/contributing).
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/hoppr/hoppr-cyclonedx-models",
"name": "hoppr-cyclonedx-models",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.2,<4.0.0",
"maintainer_email": "",
"keywords": "pydantic,models,cyclonedx,software bill of materials",
"author": "LMCO Open Source",
"author_email": "open.source@lmco.com",
"download_url": "https://files.pythonhosted.org/packages/94/f4/65468129b956dc1dfcece86b253d18ae7031773d350bf605126d512fd93d/hoppr_cyclonedx_models-0.5.5.tar.gz",
"platform": null,
"description": "# Hoppr CycloneDX Models\n\n\n[](https://pypi.org/project/hoppr-cyclonedx-models)\n[](https://pypi.org/project/hoppr-cyclonedx-models)\n[](LICENSE)\n[](https://python-poetry.org/)\n\nSerializable CycloneDX Models. Quickly get up and running with models generated directly off the specification.\n\nCurrent generated models can be found [here](hoppr_cyclonedx_models).\n\n## Installation\n\nInstall using `pip install --upgrade hoppr-cyclonedx-models` or `poetry add hoppr-cyclonedx-models`.\n\n## A Simple Example\n\n```python\n>>> from hoppr_cyclonedx_models.cyclonedx_1_5 import Component\n>>> data = {\"type\": \"library\", \"purl\": \"pkg:pypi/django@1.11.1\", \"name\": \"django\", \"version\": \"1.11.1\"}\n>>> component = Component(**data)\n>>> component\n>>> print(component)\nComponent(\n type='library',\n mime_type=None,\n bom_ref=None,\n supplier=None,\n author=None,\n publisher=None,\n group=None,\n name='django',\n version='1.11.1',\n description=None,\n scope=<Scope.REQUIRED: 'required'>,\n hashes=None,\n licenses=None,\n copyright=None,\n cpe=None,\n purl='pkg:pypi/django@1.11.1',\n swid=None,\n modified=None,\n pedigree=None,\n externalReferences=None,\n components=None,\n evidence=None,\n releaseNotes=None,\n modelCard=None,\n data=None,\n properties=None,\n signature=None\n)\n```\n\n## Contributing\n\nFor guidance setting up a development environment and how to contribute to `hoppr-cyclonedx-models`,\nsee [Contributing to Hoppr](https://hoppr.dev/docs/development/contributing).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CycloneDX Pydantic models for easy use in your Python project.",
"version": "0.5.5",
"project_urls": {
"Homepage": "https://gitlab.com/hoppr/hoppr-cyclonedx-models",
"Repository": "https://gitlab.com/hoppr/hoppr-cyclonedx-models"
},
"split_keywords": [
"pydantic",
"models",
"cyclonedx",
"software bill of materials"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "380c08cfbfa298e896937a1f375687dd7459f3d055f6d696d617e7eff680da24",
"md5": "d9377657d82e12a87dec49866cad6754",
"sha256": "fa94103d671a6cc62300856bcd129c6cc4479ec5a7c607c157c66e938d2428a6"
},
"downloads": -1,
"filename": "hoppr_cyclonedx_models-0.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d9377657d82e12a87dec49866cad6754",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.2,<4.0.0",
"size": 74819,
"upload_time": "2023-09-27T20:06:47",
"upload_time_iso_8601": "2023-09-27T20:06:47.960821Z",
"url": "https://files.pythonhosted.org/packages/38/0c/08cfbfa298e896937a1f375687dd7459f3d055f6d696d617e7eff680da24/hoppr_cyclonedx_models-0.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "94f465468129b956dc1dfcece86b253d18ae7031773d350bf605126d512fd93d",
"md5": "e60bdc138000b30d847c8f30ca1b4896",
"sha256": "52e200a6647a40696150ba31967fb2c62c52510066d300f4eeb0bbc070d2acb7"
},
"downloads": -1,
"filename": "hoppr_cyclonedx_models-0.5.5.tar.gz",
"has_sig": false,
"md5_digest": "e60bdc138000b30d847c8f30ca1b4896",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.2,<4.0.0",
"size": 70414,
"upload_time": "2023-09-27T20:06:49",
"upload_time_iso_8601": "2023-09-27T20:06:49.379476Z",
"url": "https://files.pythonhosted.org/packages/94/f4/65468129b956dc1dfcece86b253d18ae7031773d350bf605126d512fd93d/hoppr_cyclonedx_models-0.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 20:06:49",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "hoppr",
"gitlab_project": "hoppr-cyclonedx-models",
"lcname": "hoppr-cyclonedx-models"
}
JSON