Permalink
Browse files

Update README.rst

  • Loading branch information...
1 parent 3e2319f commit c3aa958b978f3a59fb9d9d0e0d0774320adf0d32 @gmr gmr committed May 6, 2014
Showing with 33 additions and 22 deletions.
  1. +33 −22 README.rst
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 c3aa958

Please sign in to comment.