Skip to content

docs: update docs #1034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkowalleck merged 1 commit into from
Mar 30, 2026
Merged

docs: update docs #1034

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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 </usage>` for an example.
* `uv`_ manifest and lockfile are not explicitly supported.
However, uv's Python virtual environments are fully supported.
See the :doc:`docs </usage>` 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 </usage>` for an example.
Expand All @@ -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::
Expand Down
4 changes: 3 additions & 1 deletion docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/CycloneDX/cyclonedx-python/issues/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.
Expand All @@ -485,6 +485,8 @@ For uv
-------

Support for `uv`_ manifest and lockfile is not explicitly implemented, yet.
See `ticket #604 <https://github.com/CycloneDX/cyclonedx-python/issues/604>`_
and `ticket #1029 <https://github.com/CycloneDX/cyclonedx-python/issues/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.
Expand Down
Loading