docs/how-to-use/InstallSnaps.rst

   1 ****************
   2 Installing SNAPS
   3 ****************
   4
   5
   6 Install Dependencies
   7 ====================
   8 A few packages need to installed onto your system, before you can install SNAPS.
   9
  10 Git is used to download the snaps source from the OPNFV Gerrit repository.
  11
  12 Python, GCC and additional libraries are required to compile and install the packages used by SNAPS.  These
  13 dependencies need to be installed whether or not a virtual Python environment is used.
  14
  15 Note: SNAPS-OO works best under Python 2.7; however, all of the code except in snaps.openstack.provisioning.ansible
  16 should work properly within a Python 3.4.4 runtime. Ansible support will not work in any Python 3.x when the Ansible
  17 version is 2.3.0 or prior. No indications when this support will be added as of 5 May 2017.
  18
  19 CentOS 7
  20 --------
  21
  22 ::
  23
  24     sudo yum install -7 git gcc python-pip python-devel openssl-devel
  25
  26 Ubuntu
  27 ------
  28 ::
  29
  30       sudo apt-get install git python2.7-dev libssl-dev
  31
  32 Optional: Setup a Python virtual environment
  33 --------------------------------------------
  34
  35 Python 2.7 (recommend leveraging a Virtual Python runtime, e.g.
  36    `Virtualenv <https://virtualenv.pypa.io>`__, in your development
  37    environment)
  38
  39 Install SNAPS dependencies
  40 --------------------------
  41
  42 The "pip" command below needs to be executed as root, if you are not using a virtual Python environment.
  43
  44 ::
  45
  46    sudo pip install -e <path to repo>/snaps/
  47
  48 The install should now be complete and you can start using the SNAPS-OO libraries.