From 5a10837f474655c29cd4f8f44e66e011412187bc Mon Sep 17 00:00:00 2001
From: Justin Ross <jross@apache.org>
Date: Thu, 21 Apr 2016 12:51:25 +0000
Subject: QPID-7207: Add Qpid Python install directions; markdownify the
 readme; remove an obsolete file

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1740297 13f79535-47bb-0310-9956-ffa450edef68
---
 qpid/python/README.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 85 insertions(+)
 create mode 100644 qpid/python/README.md

(limited to 'qpid/python/README.md')

diff --git a/qpid/python/README.md b/qpid/python/README.md
new file mode 100644
index 0000000000..bb1388ff17
--- /dev/null
+++ b/qpid/python/README.md
@@ -0,0 +1,85 @@
+# Qpid Python
+
+This distribution contains a Python client implementation and AMQP
+conformance tests 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. Run the tests:
+
+        $ ./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. Run the tests:
+
+        $ ./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
+
+## Installation
+
+Other Qpid components depend on Qpid Python for testing.  You can use
+setup.py to install Qpid Python to a standard location:
+
+    $ python setup.py install --user
+    $ export PYTHONPATH=$HOME/.local/lib/python2.7/site-packages
+    $ export PATH=$HOME/.local/bin:$PATH
+
+    [or]
+
+    $ python setup.py install     # Uses established system paths
-- 
cgit v1.2.1