Skip to content

Commit ac8de70

Browse files
authored
docs: emphasize Python 3.11 requirement for Python dep analysis (#825)
Signed-off-by: behnazh-w <[email protected]>
1 parent 58ae2c9 commit ac8de70

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/source/pages/tutorials/detect_malicious_package.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,11 @@ Analyzing django with dependencies
168168
Macaron supports analyzing a package's dependencies and performs the same set of checks on them as it does on the main target package. To analyze the dependencies of ``[email protected]`` Python package, you can either :ref:`generate an SBOM <python-sbom>` yourself or :ref:`point Macaron to a virtual environment <python-venv-deps>` where ``django`` is installed.
169169

170170

171-
Let's assume ``/tmp/.django_venv`` is the virtual environment where ``[email protected]`` is installed. Run Macaron as follows to analyze ``django`` and its dependencies.
171+
Let's assume ``/tmp/.django_venv`` is the virtual environment where ``[email protected]`` is installed.
172+
173+
.. note:: If you want Macaron to analyze the virtual environment directly to identify the dependencies, we require Python 3.11 to be used to install the package. Alternatively, you can generate the SBOM as instructed :ref:`here <python-sbom>` and pass it to Macaron as input.
174+
175+
Run Macaron as follows to analyze ``django`` and its dependencies.
172176

173177
.. code-block:: shell
174178

0 commit comments

Comments
 (0)