Author: rhs
Date: Tue Dec 9 13:25:03 2008
New Revision: 724899
URL: http://svn.apache.org/viewvc?rev=724899&view=rev
Log:
updated README
Modified:
incubator/qpid/trunk/qpid/python/README.txt
Modified: incubator/qpid/trunk/qpid/python/README.txt
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/python/README.txt?rev=724899&r1=724898&r2=724899&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/python/README.txt (original)
+++ incubator/qpid/trunk/qpid/python/README.txt Tue Dec 9 13:25:03 2008
@@ -1,32 +1,56 @@
-= RUNNING THE PYTHON TESTS =
+= INSTALLATION =
-The tests/ directory contains a collection of python unit tests to
-exercise functions of a broker.
+Extract the release archive into a directory of your choice and set
+your PYTHONPATH accordingly:
+
+ tar -xzf qpid-python-<version>.tar.gz -C <install-prefix>
+ export PYTHONPATH=<install-prefix>/qpid-<version>/python
+
+= GETTING STARTED =
+
+The python client includes a simple hello-world example that publishes
+and consumes a message:
+
+ cp <install-prefix>/qpid-<version>/python/hello-world .
+ ./hello-world
+
+= EXAMPLES =
+
+More comprehensive examples can be found here:
+
+ cd <install-prefix>/qpid-<version>/python/examples
+
+= RUNNING THE TESTS =
+
+The "tests" directory contains a collection of unit tests for the
+python client. The "tests_0-10", "tests_0-9", and "tests_0-8"
+directories contain protocol level conformance tests for AMQP brokers
+of the specified version.
Simplest way to run the tests:
- * Run a broker on the default port
+ 1. Run a broker on the default port
- * ./run-tests
+ 2. ./run-tests -s <version>
-For additional options: ./run-tests --help
+Where <version> is one of "0-8", "0-9", or "0-10-errata".
+See the run-tests usage for for additional options:
-== Expected failures ==
+ ./run-tests -h
-Until we complete functionality, tests may fail because the tested
-functionality is missing in the broker. To skip expected failures
-in the C++ or Java brokers:
-
- ./run-tests -I <file_name>
-
-=== File List ===
-
-1. cpp_failing_0-10.txt
-2. cpp_failing_0-9.txt
-3. cpp_failing_0-8.txt
-4. java_failing_0-9.txt
-5. java_failing_0-8.txt
-6. cpp_failing_0-10_preview.txt -- will be depricated soon.
+== Expected failures ==
-If you fix a failure, please remove it from the corresponding list.
+Certain tests are expected to fail to do incomplete functionality or
+unresolved interop issues. To skip expected failures for the C++ or
+Java brokers:
+
+ ./run-tests -I <file_name>
+
+Where <file_name> is one of the following files:
+
+ * cpp_failing_0-10.txt
+ * cpp_failing_0-9.txt
+ * cpp_failing_0-8.txt
+ * java_failing_0-9.txt
+ * java_failing_0-8.txt
