docs: showcase usage with uv

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

README.md

@@ -23,6 +23,8 @@ Supported data sources are:
 * Pip's `requirements.txt` format
 * `PDM` manifest and lockfile are not explicitly supported.  
   However, PDM's Python virtual environments are fully supported. See the docs for an example.
+* `uv` manifest and lockfile are not explicitly supported.  
+  However, uv's Python virtual environments are fully supported. See the 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 docs for an example.
 

cyclonedx_py/_internal/environment.py

@@ -81,6 +81,9 @@ def make_argument_parser(**kwargs: Any) -> 'ArgumentParser':
                  • Build an SBOM from PDM environment:
                        > pdm.exe info --python
                        > %(prog)s "%%path-to-pdm-python%%"
+                 • Build an SBOM from uv environment:
+                       > uv.exe python find
+                       > %(prog)s "%%path-to-uv-python%%"
                """)
         else:  # if os_name == 'posix':
             p.epilog = dedent("""\
@@ -102,6 +105,8 @@ def make_argument_parser(**kwargs: Any) -> 'ArgumentParser':
                        $ %(prog)s "$(poetry env info --executable)"
                  • Build an SBOM from PDM environment:
                        $ %(prog)s "$(pdm info --python)"
+                 • Build an SBOM from uv environment:
+                       $ %(prog)s "$(uv python find)"
                """)
         p.add_argument('--PEP-639',
                        action='store_true',

docs/usage.rst

@@ -145,6 +145,11 @@ Examples for macOS/Linux and alike
 
    $ cyclonedx-py environment "$(pdm info --python)"
 
+.. code-block:: shell-session
+   :caption: Build an SBOM from uv environment
+
+   $ cyclonedx-py environment "$(uv python find)"
+
 Examples for Windows
 ^^^^^^^^^^^^^^^^^^^^
 
@@ -183,7 +188,7 @@ Examples for Windows
 .. code-block:: doscon
    :caption: Build an SBOM from Poetry environment
 
-   > poetry.exe env info  --executable
+   > poetry.exe env info --executable
    > cyclonedx-py environment "%path-to-poetry-python%"
 
 .. code-block:: doscon
@@ -192,6 +197,12 @@ Examples for Windows
    > pdm.exe info --python
    > cyclonedx-py environment "%path-to-pdm-python%"
 
+.. code-block:: doscon
+   :caption: Build an SBOM from uv environment
+
+   > uv.exe python find
+   > cyclonedx-py environment "%path-to-uv-python%"
+
 
 For Pipenv
 ----------
@@ -469,6 +480,22 @@ it is possible to use the functionality for Python (virtual) environments as des
 
 
 
+For uv
+-------
+
+Support for `uv`_ manifest and lockfile is not explicitly implemented, yet.
+
+However, since uv utilizes Python virtual environments under the hood,
+it is possible to use the functionality for Python (virtual) environments as described above.
+
+.. _uv: https://docs.astral.sh/uv/
+
+
+
+*****
+
+
+
 For Conda
 ---------