diff --git a/LICENSE b/LICENSE index e47e3d00861b6bb8b27b2918c6381ecd3a4fd2e4..91e36a8b854719bfddb4745db2781802549f158a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ The MIT License (MIT) Copyright (c) 2016-2018 DMS Serwis s.c. -Copyright (c) 2018-2019 SMOK sp. z o.o. +Copyright (c) 2018-2020 SMOK sp. z o.o. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index edfee7a9c546e063580bb439f3c9c6e04ce6a4a6..ca9f7db470fb2c6afa31d0b3071e24ca79331bd2 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ CoolAMQP []() []() []() -[](http://coolamqp.readthedocs.io/en/latest/?badge=latest) +[](http://coolamqp.readthedocs.io/en/latest/?badge=develop) []() A **magical** AMQP client, that uses **heavy sorcery** to achieve speeds that other AMQP clients cannot even hope to match. diff --git a/docs/conf.py b/docs/conf.py index 2edc8d78d442ca4478ebb1087e133ecb4feb4536..65811d17f4b575726d79ca8ac67c9647cf02d6b8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -32,7 +32,7 @@ source_parsers = { # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ['sphinx.ext.autodoc'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -47,7 +47,7 @@ master_doc = 'index' # General information about the project. project = u'CoolAMQP' -copyright = u'2016-2019, SMOK Serwis s.c.' +copyright = u'2016-2020, SMOK Serwis s.c.' author = u'DMS Serwis s.c.' # The version info for the project you're documenting, acts as replacement for @@ -55,9 +55,9 @@ author = u'DMS Serwis s.c.' # built documents. # # The short X.Y version. -version = '0.93' +version = '0.100' # The full version, including alpha/beta/rc tags. -release = u'0.93' +release = u'0.100a1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/tutorial.rst b/docs/tutorial.rst index e0fc3e6a6bd4585dcc54b6bc57f979d84ad0e96d..0196f57bd406c8bc8a9b19276367d98d5f979cd7 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -53,7 +53,10 @@ This will create an auto-delete and exclusive queue. After than, a consumer will _no_ack=False_ will mean that we have to manually confirm messages. You can specify a callback, that will be called with a message if one's received by this consumer. Since -we did not do that, this will go to a generic queue belonging to _Cluster_. +we did not do that, this will go to a generic queue belonging to _Cluster_. + +.. autoclass: coolamqp.clustering.Cluster +:members: _consumer_ is a _Consumer_ object. This allows us to do some things with the consumer (such as setting QoS), but most importantly it allows us to cancel it later. _consume_confirm_ is a _Future_, that will succeed @@ -75,4 +78,13 @@ This creates a message with no properties, and sends it through default (direct) Note that CoolAMQP simply considers your messages to be bags of bytes + properties. It will not modify them, nor decode, and will always expect and return bytes. -To actually get our message ... \ No newline at end of file +To actually get our message, we need to start a consumer first. To do that, just invoke: + +:: + + cluster.consume(Queue('name of the queue'), **kwargs) + +Where kwargs are passed directly to Consumer class + +.. autoclass: coolamqp.attaches.Consumer +:members: diff --git a/setup.cfg b/setup.cfg index ec4cc06fcccd5f80ff91eb697913dd83b9ad8b5d..70fafaf4a2ef1e1fc81742ab4517c4a5cd84e960 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,7 +1,7 @@ [metadata] description-file = README.md name = CoolAMQP -version = 0.98 +version = 0.100a1 license = MIT License classifiers = Programming Language :: Python