Commit fa510be761d6c5e5d7b99bb27a51d2f57fb7ac9f

Authored by Philippe Lagadec
1 parent 1395b25b

updated install docs to mention pipx

Showing 1 changed file with 9 additions and 1 deletions
INSTALL.txt
... ... @@ -4,7 +4,7 @@ How to Download and Install oletools
4 4 Pre-requisites
5 5 --------------
6 6  
7   -The recommended Python version to run oletools is the latest **Python 3.x** (3.7 for now).
  7 +The recommended Python version to run oletools is the latest **Python 3.x** (3.12 for now).
8 8 Python 2.7 is still supported, but as it will become end of life in 2020 (see https://pythonclock.org/), it is highly
9 9 recommended to switch to Python 3 now.
10 10  
... ... @@ -25,6 +25,14 @@ sudo -H pip install -U oletools
25 25  
26 26 Replace `pip` by `pip3` or `pip2` to install on a specific Python version.
27 27  
  28 +On some Linux distributions, it might not be allowed to install system-wide python packages
  29 +with pip. In that case, pipx may be a better alternative to install oletools in a user virtual
  30 +environment, and to install the command-line scripts oleid, olevba, etc:
  31 +
  32 +```text
  33 +pipx install oletools
  34 +```
  35 +
28 36 **Important**: Since version 0.50, pip will automatically create convenient command-line scripts
29 37 in /usr/local/bin to run all the oletools from any directory.
30 38  
... ...