# CycloneDX Python Library
[![shield_pypi-version]][link_pypi]
[![shield_conda-forge-version]][link_conda-forge]
[![shield_rtfd]][link_rtfd]
[![shield_gh-workflow-test]][link_gh-workflow-test]
[![shield_coverage]][link_codacy]
[![shield_ossf-best-practices]][link_ossf-best-practices]
[![shield_license]][license_file]
[![shield_website]][link_website]
[![shield_slack]][link_slack]
[![shield_groups]][link_discussion]
[![shield_twitter-follow]][link_twitter]
----
OWASP [CycloneDX][link_website] is a full-stack Bill of Materials (BOM) standard
that provides advanced supply chain capabilities for cyber risk reduction.
This Python package provides data models, validators and more,
to help you create/render/read CycloneDX documents.
**This package is not designed for standalone use. It is a software library.**
As of version `3.0.0`, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per
[official examples](https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory) linking VEX to a separate CycloneDX document.
If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout
[CycloneDX Python][cyclonedx-python] or [Jake][jake].
## Documentation
View the documentation [here](https://cyclonedx-python-library.readthedocs.io/).
## Python Support
We endeavour to support all functionality for all [current actively supported Python versions](https://www.python.org/downloads/).
However, some features may not be possible/present in older Python versions due to their lack of support.
## Changelog
See our [CHANGELOG][chaneglog_file].
## Contributing
Feel free to open issues, bugreports or pull requests.
See the [CONTRIBUTING][contributing_file] file for details.
## Copyright & License
CycloneDX Python Lib is Copyright (c) OWASP Foundation. All Rights Reserved.
Permission to modify and redistribute is granted under the terms of the Apache 2.0 license.
See the [LICENSE][license_file] file for the full license.
[cyclonedx-python]: https://github.com/CycloneDX/cyclonedx-python
[jake]: https://github.com/sonatype-nexus-community/jake
[license_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/LICENSE
[chaneglog_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/CHANGELOG.md
[contributing_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/CONTRIBUTING.md
[shield_gh-workflow-test]: https://img.shields.io/github/actions/workflow/status/CycloneDX/cyclonedx-python-lib/python.yml?branch=main&logo=GitHub&logoColor=white "build"
[shield_coverage]: https://img.shields.io/codacy/coverage/1f9d451e9cdc49ce99c2a1247adab341?logo=Codacy&logoColor=white "test coverage"
[shield_ossf-best-practices]: https://img.shields.io/cii/percentage/7956?label=OpenSSF%20best%20practices "OpenSSF best practices"
[shield_pypi-version]: https://img.shields.io/pypi/v/cyclonedx-python-lib?logo=pypi&logoColor=white&label=PyPI "PyPI"
[shield_conda-forge-version]: https://img.shields.io/conda/vn/conda-forge/cyclonedx-python-lib?logo=anaconda&logoColor=white&label=conda-forge "conda-forge"
[shield_rtfd]: https://img.shields.io/readthedocs/cyclonedx-python-library?logo=readthedocs&logoColor=white "Read the Docs"
[shield_license]: https://img.shields.io/github/license/CycloneDX/cyclonedx-python-lib?logo=open%20source%20initiative&logoColor=white "license"
[shield_website]: https://img.shields.io/badge/https://-cyclonedx.org-blue.svg "homepage"
[shield_slack]: https://img.shields.io/badge/slack-join-blue?logo=Slack&logoColor=white "slack join"
[shield_groups]: https://img.shields.io/badge/discussion-groups.io-blue.svg "groups discussion"
[shield_twitter-follow]: https://img.shields.io/badge/Twitter-follow-blue?logo=Twitter&logoColor=white "twitter follow"
[link_gh-workflow-test]: https://github.com/CycloneDX/cyclonedx-python-lib/actions/workflows/python.yml?query=branch%3Amain
[link_pypi]: https://pypi.org/project/cyclonedx-python-lib/
[link_conda-forge]: https://anaconda.org/conda-forge/cyclonedx-python-lib
[link_rtfd]: https://cyclonedx-python-library.readthedocs.io/en/latest/
[link_codacy]: https://app.codacy.com/gh/CycloneDX/cyclonedx-python-lib
[link_ossf-best-practices]: https://www.bestpractices.dev/projects/7956
[link_website]: https://cyclonedx.org/
[link_slack]: https://cyclonedx.org/slack/invite
[link_discussion]: https://groups.io/g/CycloneDX
[link_twitter]: https://twitter.com/CycloneDX_Spec
[PEP-508]: https://www.python.org/dev/peps/pep-0508/
Raw data
{
"_id": null,
"home_page": "https://github.com/CycloneDX/cyclonedx-python-lib/#readme",
"name": "cyclonedx-python-lib",
"maintainer": "Jan Kowalleck",
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": "jan.kowalleck@gmail.com",
"keywords": "CycloneDX, library, OWASP, SCA, Software Bill of Materials, Bill of Materials, BOM, SBOM, VEX, VDR, OBOM, MBOM, SaaSBOM, SPDX, PackageURL, PURL",
"author": "Paul Horton",
"author_email": "phorton@sonatype.com",
"download_url": "https://files.pythonhosted.org/packages/5f/5e/92fbc03f1ab980ccd2b942e3b3cda0c60a5828a673837b4ee1eaceb924a0/cyclonedx_python_lib-8.4.0.tar.gz",
"platform": null,
"description": "# CycloneDX Python Library\n\n[![shield_pypi-version]][link_pypi]\n[![shield_conda-forge-version]][link_conda-forge]\n[![shield_rtfd]][link_rtfd]\n[![shield_gh-workflow-test]][link_gh-workflow-test]\n[![shield_coverage]][link_codacy]\n[![shield_ossf-best-practices]][link_ossf-best-practices]\n[![shield_license]][license_file] \n[![shield_website]][link_website]\n[![shield_slack]][link_slack]\n[![shield_groups]][link_discussion]\n[![shield_twitter-follow]][link_twitter]\n\n----\n\nOWASP [CycloneDX][link_website] is a full-stack Bill of Materials (BOM) standard\nthat provides advanced supply chain capabilities for cyber risk reduction.\n\nThis Python package provides data models, validators and more, \nto help you create/render/read CycloneDX documents.\n\n**This package is not designed for standalone use. It is a software library.**\n\nAs of version `3.0.0`, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per\n[official examples](https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory) linking VEX to a separate CycloneDX document.\n\nIf you're looking for a CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout \n[CycloneDX Python][cyclonedx-python] or [Jake][jake].\n\n## Documentation\n\nView the documentation [here](https://cyclonedx-python-library.readthedocs.io/).\n\n## Python Support\n\nWe endeavour to support all functionality for all [current actively supported Python versions](https://www.python.org/downloads/).\nHowever, some features may not be possible/present in older Python versions due to their lack of support.\n\n## Changelog\n\nSee our [CHANGELOG][chaneglog_file].\n\n## Contributing\n\nFeel free to open issues, bugreports or pull requests. \nSee the [CONTRIBUTING][contributing_file] file for details.\n\n## Copyright & License\n\nCycloneDX Python Lib is Copyright (c) OWASP Foundation. All Rights Reserved. \nPermission to modify and redistribute is granted under the terms of the Apache 2.0 license. \nSee the [LICENSE][license_file] file for the full license.\n\n[cyclonedx-python]: https://github.com/CycloneDX/cyclonedx-python\n[jake]: https://github.com/sonatype-nexus-community/jake\n\n[license_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/LICENSE\n[chaneglog_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/CHANGELOG.md\n[contributing_file]: https://github.com/CycloneDX/cyclonedx-python-lib/blob/master/CONTRIBUTING.md\n\n[shield_gh-workflow-test]: https://img.shields.io/github/actions/workflow/status/CycloneDX/cyclonedx-python-lib/python.yml?branch=main&logo=GitHub&logoColor=white \"build\"\n[shield_coverage]: https://img.shields.io/codacy/coverage/1f9d451e9cdc49ce99c2a1247adab341?logo=Codacy&logoColor=white \"test coverage\"\n[shield_ossf-best-practices]: https://img.shields.io/cii/percentage/7956?label=OpenSSF%20best%20practices \"OpenSSF best practices\"\n[shield_pypi-version]: https://img.shields.io/pypi/v/cyclonedx-python-lib?logo=pypi&logoColor=white&label=PyPI \"PyPI\"\n[shield_conda-forge-version]: https://img.shields.io/conda/vn/conda-forge/cyclonedx-python-lib?logo=anaconda&logoColor=white&label=conda-forge \"conda-forge\"\n[shield_rtfd]: https://img.shields.io/readthedocs/cyclonedx-python-library?logo=readthedocs&logoColor=white \"Read the Docs\"\n[shield_license]: https://img.shields.io/github/license/CycloneDX/cyclonedx-python-lib?logo=open%20source%20initiative&logoColor=white \"license\"\n[shield_website]: https://img.shields.io/badge/https://-cyclonedx.org-blue.svg \"homepage\"\n[shield_slack]: https://img.shields.io/badge/slack-join-blue?logo=Slack&logoColor=white \"slack join\"\n[shield_groups]: https://img.shields.io/badge/discussion-groups.io-blue.svg \"groups discussion\"\n[shield_twitter-follow]: https://img.shields.io/badge/Twitter-follow-blue?logo=Twitter&logoColor=white \"twitter follow\"\n\n[link_gh-workflow-test]: https://github.com/CycloneDX/cyclonedx-python-lib/actions/workflows/python.yml?query=branch%3Amain\n[link_pypi]: https://pypi.org/project/cyclonedx-python-lib/\n[link_conda-forge]: https://anaconda.org/conda-forge/cyclonedx-python-lib\n[link_rtfd]: https://cyclonedx-python-library.readthedocs.io/en/latest/\n[link_codacy]: https://app.codacy.com/gh/CycloneDX/cyclonedx-python-lib\n[link_ossf-best-practices]: https://www.bestpractices.dev/projects/7956\n[link_website]: https://cyclonedx.org/\n[link_slack]: https://cyclonedx.org/slack/invite\n[link_discussion]: https://groups.io/g/CycloneDX\n[link_twitter]: https://twitter.com/CycloneDX_Spec\n\n[PEP-508]: https://www.python.org/dev/peps/pep-0508/\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python library for CycloneDX",
"version": "8.4.0",
"project_urls": {
"Bug Tracker": "https://github.com/CycloneDX/cyclonedx-python-lib/issues",
"Documentation": "https://cyclonedx-python-library.readthedocs.io/",
"Funding": "https://owasp.org/donate/?reponame=www-project-cyclonedx&title=OWASP+CycloneDX",
"Homepage": "https://github.com/CycloneDX/cyclonedx-python-lib/#readme",
"Repository": "https://github.com/CycloneDX/cyclonedx-python-lib"
},
"split_keywords": [
"cyclonedx",
" library",
" owasp",
" sca",
" software bill of materials",
" bill of materials",
" bom",
" sbom",
" vex",
" vdr",
" obom",
" mbom",
" saasbom",
" spdx",
" packageurl",
" purl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6ea06f889b4485e83787244e7fbb21d1060b95d2b3bed564414610d596cb2032",
"md5": "f0ae0e92502e5f3f94d49ef5057dac08",
"sha256": "fd44efd601f651c8865acf0dfeacb0df19a2b50ec69ead0262096fd2f67197b9"
},
"downloads": -1,
"filename": "cyclonedx_python_lib-8.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f0ae0e92502e5f3f94d49ef5057dac08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 372295,
"upload_time": "2024-10-29T09:36:03",
"upload_time_iso_8601": "2024-10-29T09:36:03.382097Z",
"url": "https://files.pythonhosted.org/packages/6e/a0/6f889b4485e83787244e7fbb21d1060b95d2b3bed564414610d596cb2032/cyclonedx_python_lib-8.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f5e92fbc03f1ab980ccd2b942e3b3cda0c60a5828a673837b4ee1eaceb924a0",
"md5": "c8087cddb2ca42d483148eba2de9370c",
"sha256": "1d86efc1e81c0fd01141658b8aed5248c4f4d8d300d7ced9e1dfc39abeafc0a9"
},
"downloads": -1,
"filename": "cyclonedx_python_lib-8.4.0.tar.gz",
"has_sig": false,
"md5_digest": "c8087cddb2ca42d483148eba2de9370c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 1131530,
"upload_time": "2024-10-29T09:36:05",
"upload_time_iso_8601": "2024-10-29T09:36:05.575597Z",
"url": "https://files.pythonhosted.org/packages/5f/5e/92fbc03f1ab980ccd2b942e3b3cda0c60a5828a673837b4ee1eaceb924a0/cyclonedx_python_lib-8.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 09:36:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CycloneDX",
"github_project": "cyclonedx-python-lib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "cyclonedx-python-lib"
}
JSON
