summaryrefslogtreecommitdiff
path: root/kombu/transport/pyamqp.py
diff options
context:
space:
mode:
Diffstat (limited to 'kombu/transport/pyamqp.py')
-rw-r--r--kombu/transport/pyamqp.py36
1 files changed, 35 insertions, 1 deletions
diff --git a/kombu/transport/pyamqp.py b/kombu/transport/pyamqp.py
index 3a2763b9..63c0a973 100644
--- a/kombu/transport/pyamqp.py
+++ b/kombu/transport/pyamqp.py
@@ -1,4 +1,38 @@
-"""Pure-Python amqp transport."""
+"""pyamqp transport module for Kombu.
+
+Pure-Python amqp transport using py-amqp library.
+
+Features
+========
+* Type: Native
+* Supports Direct: Yes
+* Supports Topic: Yes
+* Supports Fanout: Yes
+* Supports Priority: Yes
+* Supports TTL: Yes
+
+Connection String
+=================
+Connection string can have the following formats:
+
+.. code-block::
+
+ amqp://[USER:PASSWORD@]BROKER_ADDRESS[:PORT][/VIRTUALHOST]
+ [USER:PASSWORD@]BROKER_ADDRESS[:PORT][/VIRTUALHOST]
+ amqp://
+
+For TLS encryption use:
+
+.. code-block::
+
+ amqps://[USER:PASSWORD@]BROKER_ADDRESS[:PORT][/VIRTUALHOST]
+
+Transport Options
+=================
+Transport Options are passed to constructor of underlying py-amqp
+:class:`~kombu.connection.Connection` class.
+"""
+
import amqp