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

4 files changed, 89 insertions, 65 deletions

diff --git a/qpid/python/.gitignore b/qpid/python/.gitignore
new file mode 100644
index 0000000000..4fca027dea
--- /dev/null
+++ b/qpid/python/.gitignore
@@ -0,0 +1,3 @@
+MANIFEST
+build
+dist
diff --git a/qpid/python/MANIFEST.in b/qpid/python/MANIFEST.in
index ca53073c04..a8a4f1d063 100644
--- a/qpid/python/MANIFEST.in
+++ b/qpid/python/MANIFEST.in
@@ -1,3 +1,4 @@
 recursive-include examples *
 recursive-exclude examples verify verify.in
 include *.txt
+include *.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
diff --git a/qpid/python/README.txt b/qpid/python/README.txt
deleted file mode 100644
index e076e2d216..0000000000
--- a/qpid/python/README.txt
+++ /dev/null
@@ -1,65 +0,0 @@
-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