Correcting minor issues with the documentation
[snaps.git] / 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 CentOS 7
16 --------
17
18 ::
19
20     sudo yum install -7 git gcc python-pip python-devel openssl-devel
21
22 Ubuntu
23 ------
24 ::
25
26       sudo apt-get install git python2.7-dev libssl-dev
27
28 Optional: Setup a Python virtual environment
29 --------------------------------------------
30
31 Python 2.7 (recommend leveraging a Virtual Python runtime, e.g.
32    `Virtualenv <https://virtualenv.pypa.io>`__, in your development
33    environment)
34
35 Install SNAPS dependencies
36 --------------------------
37
38 The "pip" command below needs to be executed as root, if you are not using a virtual Python environment.
39
40 ::
41
42    sudo pip install -e <path to repo>/snaps/
43
44 The install should now be complete and you can start using the SNAPS-OO libraries.