docs/installation.md

   1 # Installing toit
   2
   3 The test suite requires Python 3.3 and relies on a number of other packages. These need to be installed for the test suite to function.
   4 To install Python 3.3 in CentOS 7, an additional repository, Software Collections (see https://www.softwarecollections.org/en/scls/rhscl/python33) should be enabled.
   5
   6 Install the requirements as specified below.
   7
   8 ---
   9 ## Enable Software Collections (SCL)
  10
  11 ```bash
  12 yum -y install scl-utils
  13 yum -y install https://www.softwarecollections.org/en/scls/rhscl/python33/epel-7-x86_64/download/rhscl-python33-epel-7-x86_64.noarch.rpm
  14 ```
  15
  16 ## System packages
  17
  18 There are a number of packages that must be installed using `yum`. These can be installed like so:
  19
  20 ```bash
  21 yum -y --exclude=python33-mod_wsgi* install python33-* pciutils
  22 ```
  23
  24 ---
  25
  26 ## Python 3 Packages
  27
  28 To avoid file permission errors and Python version issues, use virtualenv to create an isolated environment with Python3.
  29 The required Python 3 packages can be found in the `requirements.txt` file in the root of the test suite.
  30 They can be installed in your virtual environment like so:
  31
  32 ```bash
  33 scl enable python33 bash
  34 # Create virtual environment
  35 virtualenv vsperfenv
  36 cd vsperfenv
  37 source bin/activate
  38 pip install -r requirements.txt
  39 ```
  40
  41 You need to activate the virtual environment every time you start a new shell session.
  42 To activate, simple run:
  43
  44 ```bash
  45 scl enable python33 bash
  46 cd vsperfenv
  47 source bin/activate
  48 ```
  49
  50 ---
  51
  52 # Working Behind a Proxy
  53
  54 If you're behind a proxy, you'll likely want to configure this before running any of the above. For example:
  55
  56 ```bash
  57 export http_proxy=proxy.mycompany.com:123
  58 export https_proxy=proxy.mycompany.com:123
  59 ```
  60
  61 ---