This file is indexed.

/usr/share/pyshared/carrot-0.10.7.egg-info/PKG-INFO is in python-carrot 0.10.7-1ubuntu1.

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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
Metadata-Version: 1.1
Name: carrot
Version: 0.10.7
Summary: AMQP Messaging Framework for Python
Home-page: http://github.com/ask/carrot/
Author: Ask Solem
Author-email: ask@celeryproject.org
License: UNKNOWN
Description: ##############################################
         carrot - AMQP Messaging Framework for Python
        ##############################################
        
        :Version: 0.10.7
        
        **NOTE** This release contains backward-incompatible changes.
        Please read the `Changelog`_ for more information.
        
        .. _`Changelog`: http://ask.github.com/carrot/changelog.html
        
        
        Introduction
        ------------
        
        `carrot` is an `AMQP`_ messaging queue framework. AMQP is the Advanced Message
        Queuing Protocol, an open standard protocol for message orientation, queuing,
        routing, reliability and security.
        
        The aim of `carrot` is to make messaging in Python as easy as possible by
        providing a high-level interface for producing and consuming messages. At the
        same time it is a goal to re-use what is already available as much as possible.
        
        `carrot` has pluggable messaging back-ends, so it is possible to support
        several messaging systems. Currently, there is support for `AMQP`_
        (`py-amqplib`_, `pika`_), `STOMP`_ (`python-stomp`_). There's also an
        in-memory backend for testing purposes, using the `Python queue module`_.
        
        Several AMQP message broker implementations exists, including `RabbitMQ`_,
        `ZeroMQ`_ and `Apache ActiveMQ`_. You'll need to have one of these installed,
        personally we've been using `RabbitMQ`_.
        
        Before you start playing with ``carrot``, 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/
        .. _`ZeroMQ`: http://www.zeromq.org/
        .. _`AMQP`: http://amqp.org
        .. _`STOMP`: http://stomp.codehaus.org
        .. _`python-stomp`: http://bitbucket.org/asksol/python-stomp
        .. _`Python Queue module`: http://docs.python.org/library/queue.html
        .. _`Apache ActiveMQ`: http://activemq.apache.org/
        .. _`Django`: http://www.djangoproject.com/
        .. _`Rabbits and warrens`: http://blogs.digitar.com/jjww/2009/01/rabbits-and-warrens/
        .. _`py-amqplib`: http://barryp.org/software/py-amqplib/
        .. _`pika`: http://github.com/tonyg/pika
        .. _`Wikipedia article about AMQP`: http://en.wikipedia.org/wiki/AMQP
        
        Documentation
        -------------
        
        Carrot is using Sphinx, and the latest documentation is available at GitHub:
        
            http://github.com/ask/carrot/
        
        Installation
        ============
        
        You can install ``carrot`` either via the Python Package Index (PyPI)
        or from source.
        
        To install using ``pip``,::
        
            $ pip install carrot
        
        
        To install using ``easy_install``,::
        
            $ easy_install carrot
        
        
        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:
        
            * Publishers
        
                Publishers 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"``.
        
        
        Examples
        ========
        
        Creating a connection
        ---------------------
        
            You can set up a connection by creating an instance of
            ``carrot.messaging.BrokerConnection``, with the appropriate options for
            your broker:
        
            >>> from carrot.connection import BrokerConnection
            >>> conn = BrokerConnection(hostname="localhost", port=5672,
            ...                           userid="test", password="test",
            ...                           virtual_host="test")
        
        
            If you're using Django you can use the
            ``carrot.connection.DjangoBrokerConnection`` class instead, which loads
            the connection settings from your ``settings.py``::
        
               BROKER_HOST = "localhost"
               BROKER_PORT = 5672
               BROKER_USER = "test"
               BROKER_PASSWORD = "secret"
               BROKER_VHOST = "/test"
        
            Then create a connection by doing:
        
                >>> from carrot.connection import DjangoBrokerConnection
                >>> conn = DjangoBrokerConnection()
        
        
        
        Receiving messages using a Consumer
        -----------------------------------
        
        First we open up a Python shell and start a message consumer.
        
        This consumer declares a queue named ``"feed"``, receiving messages with
        the routing key ``"importer"`` from the ``"feed"`` exchange.
        
        The example then uses the consumers ``wait()`` method to go into consume
        mode, where it continuously polls the queue for new messages, and when a
        message is received it passes the message to all registered callbacks.
        
            >>> from carrot.messaging import Consumer
            >>> consumer = Consumer(connection=conn, queue="feed",
            ...                     exchange="feed", routing_key="importer")
            >>> def import_feed_callback(message_data, message):
            ...     feed_url = message_data["import_feed"]
            ...     print("Got feed import message for: %s" % feed_url)
            ...     # something importing this feed url
            ...     # import_feed(feed_url)
            ...     message.ack()
            >>> consumer.register_callback(import_feed_callback)
            >>> consumer.wait() # Go into the consumer loop.
        
        Sending messages using a Publisher
        ----------------------------------
        
        Then we open up another Python shell to send some messages to the consumer
        defined in the last section.
        
            >>> from carrot.messaging import Publisher
            >>> publisher = Publisher(connection=conn,
            ...                       exchange="feed", routing_key="importer")
            >>> publisher.send({"import_feed": "http://cnn.com/rss/edition.rss"})
            >>> publisher.close()
        
        
        Look in the first Python shell again (where ``consumer.wait()`` is running),
        where the following text has been printed to the screen::
        
           Got feed import message for: http://cnn.com/rss/edition.rss  
        
        
        Serialization of Data
        -----------------------
        
        By default every message is encoded using `JSON`_, so sending
        Python data structures like dictionaries and lists works.
        `YAML`_, `msgpack`_ and Python's built-in ``pickle`` module is also supported,
        and if needed you can register any custom serialization scheme you
        want to use.
        
        .. _`JSON`: http://www.json.org/
        .. _`YAML`: http://yaml.org/
        .. _`msgpack`: http://msgpack.sourceforge.net/
        
        Each option has its advantages and disadvantages.
        
        ``json`` -- JSON is supported in many programming languages, is now
            a standard part of Python (since 2.6), and is fairly fast to 
            decode using the modern Python libraries such as ``cjson or 
            ``simplejson``.
            
            The primary disadvantage to ``JSON`` is that it limits you to 
            the following data types: strings, unicode, floats, boolean, 
            dictionaries, and lists.  Decimals and dates are notably missing.
            
            Also, binary data will be transferred using base64 encoding, which
            will cause the transferred data to be around 34% larger than an 
            encoding which supports native binary types. 
            
            However, if your data fits inside the above constraints and 
            you need cross-language support, the default setting of ``JSON``
            is probably your best choice. 
            
        ``pickle`` -- If you have no desire to support any language other than
            Python, then using the ``pickle`` encoding will gain you 
            the support of all built-in Python data types (except class instances), 
            smaller messages when sending binary files, and a slight speedup
            over ``JSON`` processing.
        
        ``yaml`` -- YAML has many of the same characteristics as ``json``, 
            except that it natively supports more data types (including dates, 
            recursive references, etc.)
            
            However, the Python libraries for YAML are a good bit slower
            than the libraries for JSON. 
            
            If you need a more expressive set of data types and need to maintain
            cross-language compatibility, then ``YAML`` may be a better fit
            than the above. 
        
        To instruct carrot to use an alternate serialization method, 
        use one of the following options.
        
            1.  Set the serialization option on a per-Publisher basis: 
                
                    >>> from carrot.messaging import Publisher
                    >>> publisher = Publisher(connection=conn,
                    ...                       exchange="feed", routing_key="importer",
                    ...                       serializer="yaml")
        
            2.  Set the serialization option on a per-call basis
        
                    >>> from carrot.messaging import Publisher
                    >>> publisher = Publisher(connection=conn,
                    ...                       exchange="feed", routing_key="importer")
                    >>> publisher.send({"import_feed": "http://cnn.com/rss/edition.rss"}, 
                    ...                serializer="pickle")
                    >>> publisher.close()
        
        Note that ``Consumer``s do not need the serialization method specified in 
        their code.  They can auto-detect the serialization method since we supply 
        the ``Content-type`` header as part of the AMQP message.
        
        
        Sending raw data without Serialization
        ---------------------------------------
        
        In some cases, you don't need your message data to be serialized. If you
        pass in a plain string or unicode object as your message, then carrot will
        not waste cycles serializing/deserializing the data.
        
        You can optionally specify a ``content_type`` and ``content_encoding``
        for the raw data:
        
            >>> from carrot.messaging import Publisher
            >>> publisher = Publisher(connection=conn,
            ...                       exchange="feed",
                                      routing_key="import_pictures")
            >>> publisher.send(open('~/my_picture.jpg','rb').read(), 
                               content_type="image/jpeg", 
                               content_encoding="binary")
            >>> publisher.close()
            
        The ``message`` object returned by the ``Consumer`` class will have a 
        ``content_type`` and ``content_encoding`` attribute. 
        
        
        Receiving messages without a callback
        --------------------------------------
        
        You can also poll the queue manually, by using the ``fetch`` method.
        This method returns a ``Message`` object, from where you can get the
        message body, de-serialize the body to get the data, acknowledge, reject or
        re-queue the message.
        
            >>> consumer = Consumer(connection=conn, queue="feed",
            ...                     exchange="feed", routing_key="importer")
            >>> message = consumer.fetch()
            >>> if message:
            ...    message_data = message.payload
            ...    message.ack()
            ... else:
            ...     # No messages waiting on the queue.
            >>> consumer.close()
        
        Sub-classing the messaging classes
        ----------------------------------
        
        The ``Consumer``, and ``Publisher`` classes can also be sub classed. Thus you
        can define the above publisher and consumer like so:
        
            >>> from carrot.messaging import Publisher, Consumer
        
            >>> class FeedPublisher(Publisher):
            ...     exchange = "feed"
            ...     routing_key = "importer"
            ...
            ...     def import_feed(self, feed_url):
            ...         return self.send({"action": "import_feed",
            ...                           "feed_url": feed_url})
        
            >>> class FeedConsumer(Consumer):
            ...     queue = "feed"
            ...     exchange = "feed"
            ...     routing_key = "importer"
            ...
            ...     def receive(self, message_data, message):
            ...         action = message_data["action"]
            ...         if action == "import_feed":
            ...             # something importing this feed
            ...             # import_feed(message_data["feed_url"])
                            message.ack()
            ...         else:
            ...             raise Exception("Unknown action: %s" % action)
        
            >>> publisher = FeedPublisher(connection=conn)
            >>> publisher.import_feed("http://cnn.com/rss/edition.rss")
            >>> publisher.close()
        
            >>> consumer = FeedConsumer(connection=conn)
            >>> consumer.wait() # Go into the consumer loop.
        
        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/carrot/issues/
        
        Contributing
        ============
        
        Development of ``carrot`` happens at Github: http://github.com/ask/carrot
        
        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 :: 4 - Beta
Classifier: Framework :: Django
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Topic :: Communications
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: Software Development :: Libraries :: Python Modules