Peter M. Groen / oletools

Commit 96de55c50550ca29ae04b888d6c2812606d40871

Authored by decalage2
1 parent 66347e8e

updated install.txt

Inline Side-by-side
Showing 1 changed file with 67 additions and 11 deletions
INSTALL.txt
  View file @96de55c
1   -How to Download and Install python-oletools
2   -===========================================
  1 +How to Download and Install oletools
  2 +====================================
3 3  
4 4 Pre-requisites
5 5 --------------
6 6  
7   -The recommended Python version to run oletools is Python 2.7.
8   -Python 2.6 is also supported, but as it is not tested as often as 2.7, some features
9   -might not work as expected.
10   -
11   -Since v0.50, oletools can also run with Python 3.x. As this is quite new, please
12   -report any issue you may encounter.
13   -
  7 +The recommended Python version to run oletools is the latest **Python 3.x** (3.7 for now).
  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 +recommended to switch to Python 3 now.
14 10  
15 11 Recommended way to Download+Install/Update oletools: pip
16 12 --------------------------------------------------------
... ... @@ -23,7 +19,17 @@ system, either upgrade Python or see https://pip.pypa.io/en/stable/installing/
23 19 To download and install/update the latest release version of oletools,
24 20 run the following command in a shell:
25 21  
  22 +```text
26 23 sudo -H pip install -U oletools
  24 +```
  25 +
  26 +Replace `pip` by `pip3` or `pip2` to install on a specific Python version.
  27 +
  28 +**New in v0.54:** To enable the decryption of encrypted documents, you also need to install the msoffcrypto-tool package:
  29 +```text
  30 +sudo -H pip install -U msoffcrypto-tool
  31 +```
  32 +
27 33  
28 34 **Important**: Since version 0.50, pip will automatically create convenient command-line scripts
29 35 in /usr/local/bin to run all the oletools from any directory.
... ... @@ -33,7 +39,24 @@ in /usr/local/bin to run all the oletools from any directory.
33 39 To download and install/update the latest release version of oletools,
34 40 run the following command in a cmd window:
35 41  
  42 +```text
36 43 pip install -U oletools
  44 +```
  45 +
  46 +Replace `pip` by `pip3` or `pip2` to install on a specific Python version.
  47 +
  48 +**Note**: with Python 3, you may need to open a cmd window with Administrator privileges in order to run pip
  49 +and install for all users. If that is not possible, you may also install only for the current user
  50 +by adding the `--user` option:
  51 +
  52 +```text
  53 +pip3 install -U --user oletools
  54 +```
  55 +
  56 +**New in v0.54:** To enable the decryption of encrypted documents, you also need to install the msoffcrypto-tool package:
  57 +```text
  58 +pip install -U msoffcrypto-tool
  59 +```
37 60  
38 61 **Important**: Since version 0.50, pip will automatically create convenient command-line scripts
39 62 to run all the oletools from any directory: olevba, mraptor, oleid, rtfobj, etc.
... ... @@ -47,18 +70,44 @@ you may also use pip:
47 70  
48 71 ### Linux, Mac OSX, Unix
49 72  
  73 +```text
50 74 sudo -H pip install -U https://github.com/decalage2/oletools/archive/master.zip
  75 +```
  76 +
  77 +Replace `pip` by `pip3` or `pip2` to install on a specific Python version.
  78 +
  79 +**New in v0.54:** To enable the decryption of encrypted documents, you also need to install the msoffcrypto-tool package:
  80 +```text
  81 +sudo -H pip install -U msoffcrypto-tool
  82 +```
51 83  
52 84 ### Windows
53 85  
  86 +```text
54 87 pip install -U https://github.com/decalage2/oletools/archive/master.zip
  88 +```
  89 +
  90 +Replace `pip` by `pip3` or `pip2` to install on a specific Python version.
  91 +
  92 +**Note**: with Python 3, you may need to open a cmd window with Administrator privileges in order to run pip
  93 +and install for all users. If that is not possible, you may also install only for the current user
  94 +by adding the `--user` option:
  95 +
  96 +```text
  97 +pip3 install -U --user https://github.com/decalage2/oletools/archive/master.zip
  98 +```
  99 +
  100 +**New in v0.54:** To enable the decryption of encrypted documents, you also need to install the msoffcrypto-tool package:
  101 +```text
  102 +pip install -U msoffcrypto-tool
  103 +```
55 104  
56 105  
57 106 How to install offline - Computer without Internet access
58 107 ---------------------------------------------------------
59 108  
60 109 First, download the oletools archive on a computer with Internet access:
61   -* Latest stable version: from https://github.com/decalage2/oletools/releases
  110 +* Latest stable version: from https://pypi.org/project/oletools/ or https://github.com/decalage2/oletools/releases
62 111 * Development version: https://github.com/decalage2/oletools/archive/master.zip
63 112  
64 113 Copy the archive file to the target computer.
... ... @@ -66,11 +115,15 @@ Copy the archive file to the target computer.
66 115 On Linux, Mac OSX, Unix, run the following command using the filename of the
67 116 archive that you downloaded:
68 117  
  118 +```text
69 119 sudo -H pip install -U oletools.zip
  120 +```
70 121  
71 122 On Windows:
72 123  
  124 +```text
73 125 pip install -U oletools.zip
  126 +```
74 127  
75 128  
76 129 Old school install using setup.py
... ... @@ -88,9 +141,12 @@ Then extract the archive, open a shell and go to the oletools directory.
88 141  
89 142 ### Linux, Mac OSX, Unix
90 143  
  144 +```text
91 145 sudo -H python setup.py install
  146 +```
92 147  
93 148 ### Windows:
94 149  
  150 +```text
95 151 python setup.py install
96   -
  152 +```
... ...