Initial release-notes.
[snaps.git] / docs / release / release-notes.rst
1 =================
2 SNAPS-OO in OPNFV
3 =================
4
5 Introduction
6 ============
7
8 SNAPS-OO is a object-oriented library designed for managing objects deployed
9 on OpenStack. In addition to its ability to deploy and manage objects, this
10 project also contains many API and integration tests that can be used to
11 validate your OpenStack cloud. Also included is a lightweight orchestrator that
12 can be used for rapid prototyping virtual environments.
13
14 Installation
15 ============
16
17 To use SNAPS-OO, it must first be installed into your Python 2.7-3.5 runtime.
18 To install:
19
20 pip install -e <SNAPS-OO directory>
21
22 Using SNAPS-OO
23 ==============
24
25 Please refer to the RST documents in ../how-to-use