openstack/trove
Code Issues Proposed changes

Improve readme.rst

Browse Source 
This file must be readable and have sections to separate usage
from tests.
Path for using trove in integration are wrong, the directory
bin does not exists.

Change-Id: I75dcf229580ead055233f8d7f7ea4acc07baadcf
Closes-Bug: #1287186
This commit is contained in:
Pierre RAMBAUD 2014-03-03 14:34:17 +01:00 committed by Pierre RAMBAUD
parent c68d4e53ba
commit 757c18c7fb
1 changed files with 41 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.rst
View File

@ -4,22 +4,48 @@ Trove
Trove is Database as a Service for Open Stack.
To run all tests and PEP8, run tox, like so:
$ tox
To quickly run the tests for Python 2.7, run:
$ tox -epy27
To quickly run PEP8, run:
$ tox -epep8
To generate a coverage report,run:
$ tox -ecover
(note: on some boxes, the results may not be accurate unless you run it twice)
=============================
Usage for integration testing
=============================
If you'd like to start up a fake Trove API daemon for integration testing
with your own tool, run:
$ ./bin/start_server
.. code-block:: bash
$ ./tools/start-fake-mode.sh
Stop the server with:
$ ./bin/stop_server
.. code-block:: bash
$ ./tools/stop-fake-mode.sh
======
Tests
======
To run all tests and PEP8, run tox, like so:
.. code-block:: bash
$ tox
To run just the tests for Python 2.7, run:
.. code-block:: bash
$ tox -epy27
To run just PEP8, run:
.. code-block:: bash
$ tox -epep8
To generate a coverage report,run:
.. code-block:: bash
$ tox -ecover
(note: on some boxes, the results may not be accurate unless you run it twice)