QPID-7207: Add Qpid Python install directions; markdownify the readme; remove an obsolete file
4 files changed
tree: a7d64d5f05c10e2290c3e0ac62f68062b6b7c14c
  1. examples/
  2. mllib/
  3. qpid/
  4. qpid_tests/
  5. .gitignore
  6. LICENSE.txt
  7. MANIFEST.in
  8. NOTICE.txt
  9. qpid-python-test
  10. qpid-python-test-ant.xml
  11. qpid-python-test.bat
  12. README.md
  13. setup.py
README.md

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