summaryrefslogtreecommitdiffstats
path: root/README.rst
blob: c115054451819ed06af03b9bc9542ec3c1d747bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
------------------
The Oslo Incubator
------------------

The Oslo program produces a set of python libraries containing
infrastructure code shared by OpenStack projects. The APIs provided by
these libraries should be high quality, stable, consistent and
generally useful.

The process of developing a new Oslo API usually begins by taking code
which is common to some OpenStack projects and moving it into this
repository. Incubation shouldn't be seen as a long term option for any
API - it is merely a stepping stone to inclusion into a published Oslo
library.

For more information, see our wiki page:

   https://wiki.openstack.org/wiki/Oslo

Running Tests
-------------

To run tests in virtualenvs (preferred):

  sudo pip install tox
  tox

To run tests in the current environment:

  sudo pip install -r requirements.txt
  nosetests