summaryrefslogtreecommitdiff
path: root/qpid/python/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'qpid/python/README.txt')
-rw-r--r--qpid/python/README.txt65
1 files changed, 65 insertions, 0 deletions
diff --git a/qpid/python/README.txt b/qpid/python/README.txt
new file mode 100644
index 0000000000..e076e2d216
--- /dev/null
+++ b/qpid/python/README.txt
@@ -0,0 +1,65 @@
+This distribution contains the Python client libraries for Apache Qpid.
+
+Apache Qpid is a high-speed, language independent, platform
+independent enterprise messaging system. It currently provides two
+messaging brokers (one implemented in C++, one implemented in Java),
+and messaging client libraries for Java JMS, C++, C# .NET, Python,
+Ruby, and WCF. The messaging protocol for Apache Qpid is AMQP
+(Advanced Message Queuing Protocol). You can read more about Qpid
+here:
+
+ http://qpid.apache.org/
+
+Documentation can be found here:
+
+ http://qpid.apache.org/documentation.html
+
+= GETTING STARTED =
+
+1. Make sure the Qpid Python client libraries are on your
+PYTHONPATH. If you have extracted the archive to the directory
+INSTALLPATH, the following export will work:
+
+$ export PYTHONPATH=${PYTHONPATH}:${INSTALLPATH}/qpid-0.8/python
+
+2. Make sure a broker is running
+
+3. Run the 'hello' example from qpid-0.8/python/examples/api:
+
+$ ./hello
+Hello world!
+
+= EXAMPLES =
+
+The examples/api directory contains several examples.
+
+Read examples/README.txt for further details on these 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.
+
+The qpid-python-test script may be used to run these tests. It will by
+default run the python unit tests and the 0-10 conformance tests:
+
+ 1. Run a broker on the default port
+
+ 2. ./qpid-python-test
+
+If you wish to run the 0-8 or 0-9 conformence tests, they may be
+selected as follows:
+
+ 1. Run a broker on the default port
+
+ 2. ./qpid-python-test tests_0-8.*
+
+ -- or --
+
+ ./qpid-python-test tests_0-9.*
+
+See the qpid-python-test usage for for additional options:
+
+ ./qpid-python-test -h