Permalink
Browse files

Merge branch 'master' of github.com:pika/pika

  • Loading branch information...
gmr committed May 6, 2014
2 parents 52f4485 + c3aa958 commit d8e55fa22888b52765e5a6784d0f442a72242e96
Showing with 33 additions and 105 deletions.
  1. +0 −83 README.md
  2. +33 −22 README.rst
View
@@ -1,83 +0,0 @@
-# Pika, an AMQP 0-9-1 client library for Python
-
-|Version| |Downloads| |Status| |Coverage| |License|
-
-## Introduction
-Pika is a pure-Python implementation of the AMQP 0-9-1 protocol that tries
-to stay fairly independent of the underlying network support library.
-
- * Currently supports Python 2.6 and Python 2.7 only. 3.2+ support planned.
-
- * Since threads aren't appropriate to every situation, it doesn't
- require threads. It takes care not to forbid them, either. The same
- goes for greenlets, callbacks, continuations and generators. It is
- not necessarily thread-safe however, and your milage will vary.
-
- * People may be using direct sockets, `asyncore`, plain old `select()`,
- or any of the wide variety of ways of getting network events to and from a
- python application. Pika tries to stay compatible with all of these, and to
- make adapting it to a new environment as simple as possible.
-
-## Documentation
-Pika's documentation is now at https://pika.readthedocs.org
-
-## Example
-Here is the most simple example of use, sending a message with the BlockingConnection adapter:
-
- import pika
- connection = pika.BlockingConnection()
- channel = connection.channel()
- channel.basic_publish(exchange='example',
- routing_key='test',
- body='Test Message')
- connection.close()
-
-And an example of writing a blocking consumer:
-
- import pika
- connection = pika.BlockingConnection()
- channel = connection.channel()
-
- for method_frame, properties, body in channel.consume('test'):
-
- # Display the message parts and ack the message
- print method_frame, properties, body
- channel.basic_ack(method_frame.delivery_tag)
-
- # Escape out of the loop after 10 messages
- if method_frame.delivery_tag == 10:
- break
-
- # Cancel the consumer and return any pending messages
- requeued_messages = channel.cancel()
- print 'Requeued %i messages' % requeued_messages
- connection.close()
-
-## Pika provides the following adapters
- * AsyncoreConnection - based off the standard Python library asyncore
- * BlockingConnection - enables blocking, synchronous operation on top of
- library for simple uses
- * SelectConnection - fast asynchronous adapter
- * TwistedConnection - adapter for use with the Twisted asynchronous package http://twistedmatrix.com/
- * TornadoConnection - adapter for use with the Tornado IO Loop http://tornadoweb.org
- * LibevConnection - adapter for use with the libev event loop http://libev.schmorp.de
-
-## License
-Pika is licensed under the MPLv2. If you have any questions regarding licensing,
-please contact the RabbitMQ team at <info@rabbitmq.com>.
-
-
-.. |Version| image:: https://badge.fury.io/py/pika.svg?
- :target: http://badge.fury.io/py/pika
-
-.. |Status| image:: https://travis-ci.org/pika/pika.svg?branch=master
- :target: https://travis-ci.org/pika/pika
-
-.. |Coverage| image:: https://coveralls.io/repos/pika/pika/badge.png
- :target: https://coveralls.io/r/pika/pika
-
-.. |Downloads| image:: https://pypip.in/d/pika/badge.svg?
- :target: https://pypi.python.org/pypi/pika
-
-.. |License| image:: https://pypip.in/license/pika/badge.svg?
- :target: https://pika.readthedocs.org
View
@@ -1,29 +1,36 @@
-# Pika, an AMQP 0-9-1 client library for Python
+Pika, an AMQP 0-9-1 client library for Python
+=============================================
|Version| |Downloads| |Status| |Coverage| |License|
-## Introduction
+Introduction
+-------------
Pika is a pure-Python implementation of the AMQP 0-9-1 protocol that tries
to stay fairly independent of the underlying network support library.
- * Currently supports Python 2.6 and Python 2.7 only. 3.2+ support planned.
+- Currently supports Python 2.6 and Python 2.7 only. 3.2+ support planned.
- * Since threads aren't appropriate to every situation, it doesn't
- require threads. It takes care not to forbid them, either. The same
- goes for greenlets, callbacks, continuations and generators. It is
- not necessarily thread-safe however, and your milage will vary.
+- Since threads aren't appropriate to every situation, it doesn't
+ require threads. It takes care not to forbid them, either. The same
+ goes for greenlets, callbacks, continuations and generators. It is
+ not necessarily thread-safe however, and your milage will vary.
- * People may be using direct sockets, `asyncore`, plain old `select()`,
- or any of the wide variety of ways of getting network events to and from a
- python application. Pika tries to stay compatible with all of these, and to
- make adapting it to a new environment as simple as possible.
+- People may be using direct sockets, `asyncore`, plain old `select()`,
+ or any of the wide variety of ways of getting network events to and from a
+ python application. Pika tries to stay compatible with all of these, and to
+ make adapting it to a new environment as simple as possible.
+
+Documentation
+-------------
-## Documentation
Pika's documentation is now at https://pika.readthedocs.org
-## Example
+Example
+-------
Here is the most simple example of use, sending a message with the BlockingConnection adapter:
+.. code :: python
+
import pika
connection = pika.BlockingConnection()
channel = connection.channel()
@@ -34,6 +41,8 @@ Here is the most simple example of use, sending a message with the BlockingConne
And an example of writing a blocking consumer:
+.. code :: python
+
import pika
connection = pika.BlockingConnection()
channel = connection.channel()
@@ -53,16 +62,18 @@ And an example of writing a blocking consumer:
print 'Requeued %i messages' % requeued_messages
connection.close()
-## Pika provides the following adapters
- * AsyncoreConnection - based off the standard Python library asyncore
- * BlockingConnection - enables blocking, synchronous operation on top of
- library for simple uses
- * SelectConnection - fast asynchronous adapter
- * TwistedConnection - adapter for use with the Twisted asynchronous package http://twistedmatrix.com/
- * TornadoConnection - adapter for use with the Tornado IO Loop http://tornadoweb.org
- * LibevConnection - adapter for use with the libev event loop http://libev.schmorp.de
+Pika provides the following adapters
+------------------------------------
+
+- AsyncoreConnection - based off the standard Python library asyncore
+- BlockingConnection - enables blocking, synchronous operation on top of library for simple uses
+- LibevConnection - adapter for use with the libev event loop http://libev.schmorp.de
+- SelectConnection - fast asynchronous adapter
+- TwistedConnection - adapter for use with the Twisted asynchronous package http://twistedmatrix.com/
+- TornadoConnection - adapter for use with the Tornado IO Loop http://tornadoweb.org
-## License
+License
+-------
Pika is licensed under the MPLv2. If you have any questions regarding licensing,
please contact the RabbitMQ team at <info@rabbitmq.com>.

0 comments on commit d8e55fa

Please sign in to comment.