Skip to content
Snippets Groups Projects
Commit 32227f9c authored by Piotr Maślanka's avatar Piotr Maślanka
Browse files

docs update

parent 77808632
No related branches found
No related tags found
No related merge requests found
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
......
......@@ -8,7 +8,7 @@ CoolAMQP
[![PyPI](https://img.shields.io/pypi/pyversions/CoolAMQP.svg)]()
[![PyPI](https://img.shields.io/pypi/implementation/CoolAMQP.svg)]()
[![PyPI](https://img.shields.io/pypi/wheel/CoolAMQP.svg)]()
[![Documentation Status](https://readthedocs.org/projects/coolamqp/badge/?version=latest)](http://coolamqp.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/coolamqp/badge/?version=latest)](http://coolamqp.readthedocs.io/en/latest/?badge=develop)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()
A **magical** AMQP client, that uses **heavy sorcery** to achieve speeds that other AMQP clients cannot even hope to match.
......
......@@ -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.
......
......@@ -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:
[metadata]
description-file = README.md
name = CoolAMQP
version = 0.98
version = 0.100a1
license = MIT License
classifiers =
Programming Language :: Python
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment