generated from oracle/template-repo
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: emphasize Python 3.11 requirement for Python dep analysis (#825)
Signed-off-by: behnazh-w <[email protected]>
- Loading branch information
Showing
1 changed file
with
5 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -168,7 +168,11 @@ Analyzing django with dependencies | |
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. | ||
|
||
|
||
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. | ||
Let's assume ``/tmp/.django_venv`` is the virtual environment where ``[email protected]`` is installed. | ||
|
||
.. 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. | ||
|
||
Run Macaron as follows to analyze ``django`` and its dependencies. | ||
|
||
.. code-block:: shell | ||
|