tempest-lib/README.rst
Matthew Treinish 781aec763e
Add note to README about tempest-lib deprecation
This commit adds a **bold** note to tempest-lib readme to explain that
tempest-lib is deprecated and explain how to use the library in tempest.

Change-Id: I7be8357d67e31d0dc51f453edf02b46dab4f6f63
2016-02-26 10:30:34 -05:00

34 lines
1.2 KiB
ReStructuredText

===========
tempest-lib
===========
OpenStack Functional Testing Library
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/tempest-lib
* Source: http://git.openstack.org/cgit/openstack/tempest-lib
* Bugs: http://bugs.launchpad.net/tempest
tempest-lib is a library of common functionality that was originally in tempest
(or similar in scope to tempest)
**As of the 1.0.0 release tempest-lib as a separate repository and project is
deprecated. The library now exists as part of the tempest project, all future
development will occur there. To use the library for future releases update
your imports from tempest_lib to tempest.lib, and add tempest>=10 to your
project requirements**
Features
--------
Some of the current functionality exposed from the library includes:
* OpenStack python-* client CLI testing framework
* subunit-trace: A output filter for subunit streams. Useful in conjunction
with calling a test runner that emits subunit
* A unified REST Client
* Utility functions:
* skip_because: Skip a test because of a bug
* find_test_caller: Perform stack introspection to find the test caller.
common methods