131 lines
6.3 KiB
Plaintext
131 lines
6.3 KiB
Plaintext
Metadata-Version: 2.3
|
|
Name: cyclonedx-python-lib
|
|
Version: 9.1.0
|
|
Summary: Python library for CycloneDX
|
|
License: Apache-2.0
|
|
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
|
|
Maintainer: Jan Kowalleck
|
|
Maintainer-email: jan.kowalleck@gmail.com
|
|
Requires-Python: >=3.8,<4.0
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Intended Audience :: Information Technology
|
|
Classifier: Intended Audience :: Legal Industry
|
|
Classifier: Intended Audience :: System Administrators
|
|
Classifier: License :: OSI Approved :: Apache Software License
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: Programming Language :: Python :: 3.13
|
|
Classifier: Topic :: Security
|
|
Classifier: Topic :: Software Development
|
|
Classifier: Topic :: System :: Software Distribution
|
|
Classifier: Typing :: Typed
|
|
Provides-Extra: json-validation
|
|
Provides-Extra: validation
|
|
Provides-Extra: xml-validation
|
|
Requires-Dist: jsonschema[format] (>=4.18,<5.0) ; extra == "validation" or extra == "json-validation"
|
|
Requires-Dist: license-expression (>=30,<31)
|
|
Requires-Dist: lxml (>=4,<6) ; extra == "validation" or extra == "xml-validation"
|
|
Requires-Dist: packageurl-python (>=0.11,<2)
|
|
Requires-Dist: py-serializable (>=2.0.0,<3.0.0)
|
|
Requires-Dist: sortedcontainers (>=2.4.0,<3.0.0)
|
|
Project-URL: Bug Tracker, https://github.com/CycloneDX/cyclonedx-python-lib/issues
|
|
Project-URL: Documentation, https://cyclonedx-python-library.readthedocs.io/
|
|
Project-URL: Funding, https://owasp.org/donate/?reponame=www-project-cyclonedx&title=OWASP+CycloneDX
|
|
Project-URL: Homepage, https://github.com/CycloneDX/cyclonedx-python-lib/#readme
|
|
Project-URL: Repository, https://github.com/CycloneDX/cyclonedx-python-lib
|
|
Description-Content-Type: text/markdown
|
|
|
|
# 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
|
|
|