Skip to content

Commit e42d0fe

Browse files
authored
docs: update docs (#1034)
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
1 parent d4a0d50 commit e42d0fe

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

docs/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ CycloneDX SBOM Generation Tool for Python
1717
=========================================
1818

1919
This tool generates Software Bill of material (SBOM) documents in OWASP `CycloneDX`_ format.
20+
This is probably the most accurate, complete SBOM generator for any python-related projects.
2021

2122
Supported data sources are:
2223

@@ -27,6 +28,9 @@ Supported data sources are:
2728
* `PDM`_ manifest and lockfile support is not implemented, yet.
2829
However, PDM's Python virtual environments are fully supported.
2930
See the :doc:`docs </usage>` for an example.
31+
* `uv`_ manifest and lockfile are not explicitly supported.
32+
However, uv's Python virtual environments are fully supported.
33+
See the :doc:`docs </usage>` for an example.
3034
* `Conda`_ as a package manager is no longer supported since version 4.
3135
However, conda's Python environments are fully supported via the methods listed above.
3236
See the :doc:`docs </usage>` for an example.
@@ -45,6 +49,7 @@ and might have properties following the Namespace Taxonomies
4549
.. _Pipenv: https://pipenv.pypa.io/
4650
.. _requirements file format: https://pip.pypa.io/en/stable/reference/requirements-file-format/
4751
.. _PDM: https://pdm-project.org/
52+
.. _uv: https://docs.astral.sh/uv/
4853
.. _Conda: https://conda.io/
4954

5055
.. toctree::

docs/usage.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ For PDM
468468
-------
469469

470470
Support for `PDM`_ manifest and lockfile is not explicitly implemented, yet.
471-
See https://github.com/CycloneDX/cyclonedx-python/issues/604
471+
See `ticket #604 <https://github.com/CycloneDX/cyclonedx-python/issues/604>`_.
472472

473473
However, since PDM utilizes Python virtual environments under the hood,
474474
it is possible to use the functionality for Python (virtual) environments as described above.
@@ -485,6 +485,8 @@ For uv
485485
-------
486486

487487
Support for `uv`_ manifest and lockfile is not explicitly implemented, yet.
488+
See `ticket #604 <https://github.com/CycloneDX/cyclonedx-python/issues/604>`_
489+
and `ticket #1029 <https://github.com/CycloneDX/cyclonedx-python/issues/1029>`_.
488490

489491
However, since uv utilizes Python virtual environments under the hood,
490492
it is possible to use the functionality for Python (virtual) environments as described above.

0 commit comments

Comments
 (0)