You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jr...@apache.org on 2016/04/21 14:51:25 UTC
svn commit: r1740297 - in /qpid/trunk/qpid: python/.gitignore
python/MANIFEST.in python/README.md python/README.txt tools/.gitignore
Author: jross
Date: Thu Apr 21 12:51:25 2016
New Revision: 1740297
URL: http://svn.apache.org/viewvc?rev=1740297&view=rev
Log:
QPID-7207: Add Qpid Python install directions; markdownify the readme; remove an obsolete file
Added:
qpid/trunk/qpid/python/.gitignore
qpid/trunk/qpid/python/README.md
Removed:
qpid/trunk/qpid/python/README.txt
qpid/trunk/qpid/tools/.gitignore
Modified:
qpid/trunk/qpid/python/MANIFEST.in
Added: qpid/trunk/qpid/python/.gitignore
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/python/.gitignore?rev=1740297&view=auto
==============================================================================
--- qpid/trunk/qpid/python/.gitignore (added)
+++ qpid/trunk/qpid/python/.gitignore Thu Apr 21 12:51:25 2016
@@ -0,0 +1,3 @@
+MANIFEST
+build
+dist
Modified: qpid/trunk/qpid/python/MANIFEST.in
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/python/MANIFEST.in?rev=1740297&r1=1740296&r2=1740297&view=diff
==============================================================================
--- qpid/trunk/qpid/python/MANIFEST.in (original)
+++ qpid/trunk/qpid/python/MANIFEST.in Thu Apr 21 12:51:25 2016
@@ -1,3 +1,4 @@
recursive-include examples *
recursive-exclude examples verify verify.in
include *.txt
+include *.md
Added: qpid/trunk/qpid/python/README.md
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/python/README.md?rev=1740297&view=auto
==============================================================================
--- qpid/trunk/qpid/python/README.md (added)
+++ qpid/trunk/qpid/python/README.md Thu Apr 21 12:51:25 2016
@@ -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
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org