Skip to content

Commit

Permalink
docs: completing docs of python' pipdeptree support
Browse files Browse the repository at this point in the history
Signed-off-by: Zvi Grinberg <[email protected]>
  • Loading branch information
zvigrinberg authored May 16, 2024
1 parent ec7a743 commit 711b039
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ A New setting is introduced - `EXHORT_PYTHON_INSTALL_BEST_EFFORTS` (as both env
##### Using `pipdeptree`
By Default, The API algorithm will use native commands of PIP installer as data source to build the dependency tree.
It's also possible, to use lightweight Python PIP utility [pipdeptree](https://pypi.org/project/pipdeptree/) as data source instead, in order to activate this,
Need to set environment variable/option - `EXHORT_PIP_USE_DEP_TREE` to true.
Need to set environment variable/system property - `EXHORT_PIP_USE_DEP_TREE` to true.

### Image Support

Expand Down Expand Up @@ -540,7 +540,8 @@ Customize image analysis optionally by using *Environment Variables* or *Java Pr
### Known Issues

- For pip requirements.txt - It's been observed that for python versions 3.11.x, there might be slowness for invoking the analysis.
Task to mitigate this issue /to make it less problematic is a WIP.
If you encounter a performance issue with python version >= 3.11.x, kindly try to set environment variable/system property `EXHORT_PIP_USE_DEP_TREE`=true, before calling the analysis - this should fix the performance issue.



- For maven pom.xml, it has been noticed that using java 17 might cause stack analysis to hang forever.
Expand Down

0 comments on commit 711b039

Please sign in to comment.