Peter M. Groen / oletools

Commit 47703991183c2850ee4442adbec275a198f95a24

Authored by decalage2
1 parent 50443239

updated install.txt

Inline Side-by-side
Showing 1 changed file with 68 additions and 35 deletions
INSTALL.txt
  View file @4770399
... ... @@ -4,60 +4,93 @@ How to Download and Install python-oletools
4 4 Pre-requisites
5 5 --------------
6 6  
7   -For now, python-oletools require Python 2.x.
8   -They are not compatible with Python 3.x yet.
  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.
9 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.
10 13  
11   -For command-line tools
12   -----------------------
13 14  
14   -To use python-oletools from the command line as analysis tools, you may simply
15   -download the latest release archive from
16   -https://github.com/decalage2/oletools/releases
17   -and extract the files into the directory of your choice.
  15 +Recommended way to Download+Install/Update oletools: pip
  16 +--------------------------------------------------------
18 17  
19   -You may also download the latest development version from
20   -https://github.com/decalage2/oletools/archive/master.zip with the most recent
21   -features.
  18 +Pip is included with Python since version 2.7.9 and 3.4. If it is not installed on your
  19 +system, either upgrade Python or see https://pip.pypa.io/en/stable/installing/
22 20  
23   -Another possibility is to use a git client to clone the repository
24   -(https://github.com/decalage2/oletools.git) into a folder.
25   -You can then update it easily in the future.
  21 +### Linux, Mac OSX, Unix
  22 +
  23 +To download and install/update the latest release version of oletools,
  24 +run the following command in a shell:
  25 +
  26 +sudo -H pip install -U oletools
  27 +
  28 +**Important**: Since version 0.50, pip will automatically create convenient command-line scripts
  29 +in /usr/local/bin to run all the oletools from any directory.
26 30  
27 31 ### Windows
28 32  
29   -You may add the oletools directory to your PATH environment variable to access
30   -the tools from anywhere.
  33 +To download and install/update the latest release version of oletools,
  34 +run the following command in a cmd window:
  35 +
  36 +pip install -U oletools
  37 +
  38 +**Important**: Since version 0.50, pip will automatically create convenient command-line scripts
  39 +to run all the oletools from any directory: olevba, mraptor, oleid, rtfobj, etc.
  40 +
  41 +
  42 +How to install the latest development version
  43 +---------------------------------------------
  44 +
  45 +If you want to benefit from the latest improvements in the development version,
  46 +you may also use pip:
31 47  
32 48 ### Linux, Mac OSX, Unix
33 49  
34   -It is very convenient to create symbolic links to each tool in one of the bin
35   -directories in order to run them as shell commands from anywhere. For example,
36   -here is how to create an executable link "olevba" in /usr/local/bin pointing to
37   -olevba.py, assuming oletools was unzipped into /opt/oletools:
  50 +sudo -H pip install -U https://github.com/decalage2/oletools/archive/master.zip
  51 +
  52 +### Windows
  53 +
  54 +pip install -U https://github.com/decalage2/oletools/archive/master.zip
  55 +
  56 +
  57 +How to install offline - Computer without Internet access
  58 +---------------------------------------------------------
  59 +
  60 +First, download the oletools archive on a computer with Internet access:
  61 +* Latest stable version: from https://github.com/decalage2/oletools/releases
  62 +* Development version: https://github.com/decalage2/oletools/archive/master.zip
38 63  
39   - chmod +x /opt/oletools/oletools/olevba.py
40   - ln -s /opt/oletools/oletools/olevba.py /usr/local/bin/olevba
  64 +Copy the archive file to the target computer.
41 65  
42   -Then the olevba command can be used from any directory:
  66 +On Linux, Mac OSX, Unix, run the following command using the filename of the
  67 +archive that you downloaded:
43 68  
44   - user@remnux:~/MalwareZoo/VBA$ olevba dridex427.xls |less
  69 +sudo -H pip install -U oletools.zip
45 70  
  71 +On Windows:
46 72  
  73 +pip install -U oletools.zip
47 74  
48   -For python applications
49   ------------------------
50 75  
51   -If you plan to use python-oletools with other Python applications or your own
52   -scripts, the simplest solution is to run "pip install oletools" or
53   -"easy_install oletools" to download and install the package in one go.
54   -Pip is included with Python since version 2.7.9.
  76 +Old school install using setup.py
  77 +---------------------------------
  78 +
  79 +If you cannot use pip, it is still possible to run the setup.py script
  80 +directly. However, this method will not create the command-line scripts
  81 +automatically.
  82 +
  83 +First, download the oletools archive:
  84 +* Latest stable version: from https://github.com/decalage2/oletools/releases
  85 +* Development version: https://github.com/decalage2/oletools/archive/master.zip
  86 +
  87 +Then extract the archive, open a shell and go to the oletools directory.
  88 +
  89 +### Linux, Mac OSX, Unix
55 90  
56   -IMPORTANT: to update oletools if it is already installed, you must run
57   -"pip install -U oletools", otherwise pip will not update it.
  91 +sudo -H python setup.py install
58 92  
59   -Alternatively if you prefer the old school way, you may download the
60   -latest archive from https://github.com/decalage2/oletools/releases, extract it
61   -into a temporary directory and run "python setup.py install".
  93 +### Windows:
62 94  
  95 +python setup.py install
63 96  
... ...