cyclonedx-python-lib


Namecyclonedx-python-lib JSON
Version 10.4.1 PyPI version JSON
download
home_pageNone
SummaryPython library for CycloneDX
upload_time2025-07-08 16:28:18
maintainerJan Kowalleck
docs_urlNone
authorPaul Horton
requires_python<4.0,>=3.9
licenseApache-2.0
keywords cyclonedx library owasp sca software bill of materials bill of materials bom sbom vex vdr obom mbom saasbom spdx packageurl purl
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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.

> [!NOTE]  
> This package is a software library not intended for standalone use.  
> For generating Software Bill of Materials (SBOM), check out [CycloneDX Python][cyclonedx-python] or [Jake][jake].

## Documentation

Complete documentation is available on [Read the Docs][link_rtfd]. This includes:
- Responsibilities & Capabilities
- Install Instructions
- API Reference
- Usage Examples
- Integration Guides
- Best Practices

## 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


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cyclonedx-python-lib",
    "maintainer": "Jan Kowalleck",
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "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/60/6d/350b5f894c3f37c13adb884baf8b492a46fbb573934545a02514ec286850/cyclonedx_python_lib-10.4.1.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> [!NOTE]  \n> This package is a software library not intended for standalone use.  \n> For generating Software Bill of Materials (SBOM), check out [CycloneDX Python][cyclonedx-python] or [Jake][jake].\n\n## Documentation\n\nComplete documentation is available on [Read the Docs][link_rtfd]. This includes:\n- Responsibilities & Capabilities\n- Install Instructions\n- API Reference\n- Usage Examples\n- Integration Guides\n- Best Practices\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",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Python library for CycloneDX",
    "version": "10.4.1",
    "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": null,
            "digests": {
                "blake2b_256": "8525d7c1d834d41c53e8a3e413e1ccc1bbba57a6eac7a5db59f01a563584a777",
                "md5": "550a9bc9024522a645c69c68202f1481",
                "sha256": "1073d5855cdab02b7367f037c47cb46f4c82cadbc745e063edbb9160290efda2"
            },
            "downloads": -1,
            "filename": "cyclonedx_python_lib-10.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "550a9bc9024522a645c69c68202f1481",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 381522,
            "upload_time": "2025-07-08T16:28:16",
            "upload_time_iso_8601": "2025-07-08T16:28:16.748695Z",
            "url": "https://files.pythonhosted.org/packages/85/25/d7c1d834d41c53e8a3e413e1ccc1bbba57a6eac7a5db59f01a563584a777/cyclonedx_python_lib-10.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "606d350b5f894c3f37c13adb884baf8b492a46fbb573934545a02514ec286850",
                "md5": "4b0345345c1edef1a0812cd6c1fa9302",
                "sha256": "ee017dee867ffb9b449b955161fd235a7c6245e87a5169998e10a0ce61292efb"
            },
            "downloads": -1,
            "filename": "cyclonedx_python_lib-10.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4b0345345c1edef1a0812cd6c1fa9302",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 1040510,
            "upload_time": "2025-07-08T16:28:18",
            "upload_time_iso_8601": "2025-07-08T16:28:18.274820Z",
            "url": "https://files.pythonhosted.org/packages/60/6d/350b5f894c3f37c13adb884baf8b492a46fbb573934545a02514ec286850/cyclonedx_python_lib-10.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-08 16:28:18",
    "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"
}
        
Elapsed time: 0.45051s