/usr/share/pyshared/kombu-2.1.8.egg-info/PKG-INFO is in python-kombu 2.1.8-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 | Metadata-Version: 1.1
Name: kombu
Version: 2.1.8
Summary: Messaging Framework for Python
Home-page: http://github.com/ask/kombu/
Author: Ask Solem
Author-email: ask@celeryproject.org
License: UNKNOWN
Description: #############################################
kombu - Messaging Framework for Python
#############################################
:Version: 2.1.8
Synopsis
========
`Kombu` is an `AMQP`_ messaging framework for Python.
AMQP is the Advanced Message Queuing Protocol, an open standard protocol
for message orientation, queuing, routing, reliability and security.
One of the most popular implementations of AMQP is `RabbitMQ`_.
The aim of `Kombu` is to make messaging in Python as easy as possible by
providing an idiomatic high-level interface for the AMQP protocol, and also
provide proven and tested solutions to common messaging problems.
Features
========
* 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`_, `Amazon SQS`_, `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 errors.
* 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.
For an introduction to AMQP you should read the article `Rabbits and warrens`_,
and the `Wikipedia article about AMQP`_.
.. _`RabbitMQ`: http://www.rabbitmq.com/
.. _`AMQP`: http://amqp.org
.. _`Redis`: http://code.google.com/p/redis/
.. _`Amazon SQS`: http://aws.amazon.com/sqs/
.. _`MongoDB`: http://www.mongodb.org/
.. _`CouchDB`: http://couchdb.apache.org/
.. _`Beanstalk`: http://kr.github.com/beanstalkd/
.. _`Rabbits and warrens`: http://blogs.digitar.com/jjww/2009/01/rabbits-and-warrens/
.. _`amqplib`: http://barryp.org/software/py-amqplib/
.. _`pika`: http://github.com/pika/pika
.. _`Wikipedia article about AMQP`: http://en.wikipedia.org/wiki/AMQP
.. _`kombu-sqlalchemy`: http://github.com/ask/kombu-sqlalchemy/
.. _`django-kombu`: http://github.com/ask/django-kombu/
.. _`carrot`: http://pypi.python.org/pypi/carrot/
Transport Comparison
====================
+---------------+----------+------------+------------+---------------+
| **Client** | **Type** | **Direct** | **Topic** | **Fanout** |
+---------------+----------+------------+------------+---------------+
| *amqplib* | Native | Yes | Yes | Yes |
+---------------+----------+------------+------------+---------------+
| *pika* | Native | Yes | Yes | Yes |
+---------------+----------+------------+------------+---------------+
| *redis* | Virtual | Yes | Yes [#f1]_ | Yes (PUB/SUB) |
+---------------+----------+------------+------------+---------------+
| *beanstalk* | Virtual | Yes | Yes [#f1]_ | No |
+---------------+----------+------------+------------+---------------+
| *SQS* | Virtual | Yes | Yes [#f1]_ | Yes [#f2]_ |
+---------------+----------+------------+------------+---------------+
| *mongodb* | Virtual | Yes | Yes [#f1]_ | Yes |
+---------------+----------+------------+------------+---------------+
| *couchdb* | Virtual | Yes | Yes [#f1]_ | No |
+---------------+----------+------------+------------+---------------+
| *in-memory* | Virtual | Yes | Yes [#f1]_ | No |
+---------------+----------+------------+------------+---------------+
.. [#f1] Declarations only kept in memory, so exchanges/queues
must be declared by all clients that needs them.
.. [#f2] Fanout supported via storing routing tables in SimpleDB.
Disabled by default, but can be enabled by using the
``supports_fanout`` transport option.
Documentation
-------------
Kombu is using Sphinx, and the latest documentation is available at GitHub:
http://ask.github.com/kombu
Quick overview
--------------
::
from kombu import BrokerConnection, Exchange, Queue
media_exchange = Exchange("media", "direct", durable=True)
video_queue = Queue("video", exchange=media_exchange, routing_key="video")
def process_media(body, message):
print body
message.ack()
# connections
with BrokerConnection("amqp://guest:guest@localhost//") as conn:
# Declare the video queue so that the messages can be delivered.
# It is a best practice in Kombu to have both publishers and
# consumers declare the queue.
video_queue(conn.channel()).declare()
# produce
with conn.Producer(exchange=media_exchange,
serializer="json", routing_key="video") as producer:
producer.publish({"name": "/tmp/lolcat1.avi", "size": 1301013})
# consume
with conn.Consumer(video_queue, callbacks=[process_media]) as consumer:
# Process messages and handle events on all channels
while True:
conn.drain_events()
# Consume from several queues on the same channel:
video_queue = Queue("video", exchange=media_exchange, key="video")
image_queue = Queue("image", exchange=media_exchange, key="image")
with connection.Consumer([video_queue, image_queue],
callbacks=[process_media]) as consumer:
while True:
connection.drain_events()
Or handle channels manually::
with connection.channel() as channel:
producer = Producer(channel, ...)
consumer = Producer(channel)
All objects can be used outside of with statements too,
just remember to close the objects after use::
from kombu import BrokerConnection, Consumer, Producer
connection = BrokerConnection()
# ...
connection.close()
consumer = Consumer(channel_or_connection, ...)
consumer.register_callback(my_callback)
consumer.consume()
# ....
consumer.cancel()
producer = Producer(channel_or_connection, ...)
# ....
producer.close()
`Exchange` and `Queue` are simply declarations that can be pickled
and used in configuration files etc.
They also support operations, but to do so they need to be bound
to a channel:
::
>>> exchange = Exchange("tasks", "direct")
>>> connection = BrokerConnection()
>>> channel = connection.channel()
>>> bound_exchange = exchange(channel)
>>> bound_exchange.delete()
# the original exchange is not affected, and stays unbound.
>>> exchange.delete()
raise NotBoundError: Can't call delete on Exchange not bound to
a channel.
Installation
============
You can install `Kombu` either via the Python Package Index (PyPI)
or from source.
To install using `pip`,::
$ pip install kombu
To install using `easy_install`,::
$ easy_install kombu
If you have downloaded a source tarball you can install it
by doing the following,::
$ python setup.py build
# python setup.py install # as root
Terminology
===========
There are some concepts you should be familiar with before starting:
* Producers
Producers sends messages to an exchange.
* Exchanges
Messages are sent to exchanges. Exchanges are named and can be
configured to use one of several routing algorithms. The exchange
routes the messages to consumers by matching the routing key in the
message with the routing key the consumer provides when binding to
the exchange.
* Consumers
Consumers declares a queue, binds it to a exchange and receives
messages from it.
* Queues
Queues receive messages sent to exchanges. The queues are declared
by consumers.
* Routing keys
Every message has a routing key. The interpretation of the routing
key depends on the exchange type. There are four default exchange
types defined by the AMQP standard, and vendors can define custom
types (so see your vendors manual for details).
These are the default exchange types defined by AMQP/0.8:
* Direct exchange
Matches if the routing key property of the message and
the `routing_key` attribute of the consumer are identical.
* Fan-out exchange
Always matches, even if the binding does not have a routing
key.
* Topic exchange
Matches the routing key property of the message by a primitive
pattern matching scheme. The message routing key then consists
of words separated by dots (`"."`, like domain names), and
two special characters are available; star (`"*"`) and hash
(`"#"`). The star matches any word, and the hash matches
zero or more words. For example `"*.stock.#"` matches the
routing keys `"usd.stock"` and `"eur.stock.db"` but not
`"stock.nasdaq"`.
Getting Help
============
Mailing list
------------
Join the `carrot-users`_ mailing list.
.. _`carrot-users`: http://groups.google.com/group/carrot-users/
Bug tracker
===========
If you have any suggestions, bug reports or annoyances please report them
to our issue tracker at http://github.com/ask/kombu/issues/
Contributing
============
Development of `Kombu` happens at Github: http://github.com/ask/kombu
You are highly encouraged to participate in the development. If you don't
like Github (for some reason) you're welcome to send regular patches.
License
=======
This software is licensed under the `New BSD License`. See the `LICENSE`
file in the top distribution directory for the full license text.
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: Jython
Classifier: Intended Audience :: Developers
Classifier: Topic :: Communications
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: System :: Networking
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|