docs/installation.rst

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