Some marketing in README

This commit is contained in:
Ask Solem 2010-11-12 15:22:23 +01:00
parent 952fc27b03
commit 35f8d577c3
1 changed files with 41 additions and 17 deletions

View File

@ -4,29 +4,53 @@
:Version: 0.9.5 :Version: 0.9.5
Introduction Synopsis
------------ ========
`Kombu` is an `AMQP`_ messaging queue framework. AMQP is the Advanced Message `Kombu` is an `AMQP`_ messaging queue framework for Python.
Queuing Protocol, an open standard protocol for message orientation, queuing,
routing, reliability and security. AMQP is the Advanced Message Queuing Protocol, an open standard protocol
for message orientation, queuing, routing, reliability and security.
The aim of `Kombu` is to make messaging in Python as easy as possible by The aim of `Kombu` is to make messaging in Python as easy as possible by
providing a high-level interface for producing and consuming messages, providing a idiomatic high-level interface for producing and consuming messages
and provide tested and proven implementations of common messaging patterns. in Python, and provide tested and proven implementations of common messaging
patterns.
`Kombu` has pluggable messaging transports, so it is possible to support Features
several messaging systems. Currently, there is support for `AMQP`_ ========
(`py-amqplib`_, `pika`_), `Redis`_, and `Beanstalk`. Also there's an
in-memory transport for testing purposes.
There are also transports available as plug-ins, like `kombu-sqlalchemy` * Tested idiomatic Python API for the AMQ protocol.
(SQLAlchemy transport), or `django-kombu`_ (transport using the Django ORM).
* Allows application authors to support several message server
solutions by using pluggable transports.
* AMQP transports for both the `amqplib` (sync) and `pika` (sync + async)
clients.
* Virtual transports makes it really easy to add support for non-AMQP
transports. There is already built-in support for `Redis`, `Beanstalk`,
`CouchDB`, and `MongoDB`.
* SQLAlchemy and Django ORM transports exists as plug-ins (
`kombu-sqlalchemy`_ and `django-kombu`_).
* In-memory transport for unit testing.
* Supports automatic encoding, serialization and compression of message
payloads.
* Consistent exception handling across transports.
* The ability to ensure that an operation is performed by gracefully
handling connection and channel errrors.
* Several annoyances with `amqplib`_ has been fixed, like supporting
timeouts and the ability to wait for events on more than one channel.
* Projects already using `carrot`_ can easily be ported by using
a compatibility layer.
Before you start playing with `Kombu`, you should probably read up on
AMQP, and you could start with the excellent article about using RabbitMQ
under Python, `Rabbits and warrens`_. For more detailed information, you can
refer to the `Wikipedia article about AMQP`_.
.. _`RabbitMQ`: http://www.rabbitmq.com/ .. _`RabbitMQ`: http://www.rabbitmq.com/
.. _`AMQP`: http://amqp.org .. _`AMQP`: http://amqp.org