From cb98a0736c9b7eb977c39443759d2ffbc1f2d8e1 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Mon, 30 Mar 2026 16:04:01 +0200 Subject: [PATCH] docs: update docs Signed-off-by: Jan Kowalleck --- docs/index.rst | 5 +++++ docs/usage.rst | 4 +++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index c9359938..afb2fba3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,6 +17,7 @@ CycloneDX SBOM Generation Tool for Python ========================================= This tool generates Software Bill of material (SBOM) documents in OWASP `CycloneDX`_ format. +This is probably the most accurate, complete SBOM generator for any python-related projects. Supported data sources are: @@ -27,6 +28,9 @@ Supported data sources are: * `PDM`_ manifest and lockfile support is not implemented, yet. However, PDM's Python virtual environments are fully supported. See the :doc:`docs ` for an example. +* `uv`_ manifest and lockfile are not explicitly supported. + However, uv's Python virtual environments are fully supported. + See the :doc:`docs ` for an example. * `Conda`_ as a package manager is no longer supported since version 4. However, conda's Python environments are fully supported via the methods listed above. See the :doc:`docs ` for an example. @@ -45,6 +49,7 @@ and might have properties following the Namespace Taxonomies .. _Pipenv: https://pipenv.pypa.io/ .. _requirements file format: https://pip.pypa.io/en/stable/reference/requirements-file-format/ .. _PDM: https://pdm-project.org/ +.. _uv: https://docs.astral.sh/uv/ .. _Conda: https://conda.io/ .. toctree:: diff --git a/docs/usage.rst b/docs/usage.rst index d5cb546f..a52efcad 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -468,7 +468,7 @@ For PDM ------- Support for `PDM`_ manifest and lockfile is not explicitly implemented, yet. -See https://github.com/CycloneDX/cyclonedx-python/issues/604 +See `ticket #604 `_. However, since PDM utilizes Python virtual environments under the hood, it is possible to use the functionality for Python (virtual) environments as described above. @@ -485,6 +485,8 @@ For uv ------- Support for `uv`_ manifest and lockfile is not explicitly implemented, yet. +See `ticket #604 `_ +and `ticket #1029 `_. However, since uv utilizes Python virtual environments under the hood, it is possible to use the functionality for Python (virtual) environments as described above.