Merge branch 'release/0.2.3'

DESCRIPTION.rst

@@ -79,5 +79,9 @@ Usage
         loop = asyncio.get_event_loop()
         loop.run_until_complete(chat())
 
-
-.. include:: docs/source/global.rst
+.. _aiohttp: https://github.com/aio-libs/aiohttp/
+.. _CometD: https://cometd.org/
+.. _Comet: https://en.wikipedia.org/wiki/Comet_(programming)
+.. _asyncio: https://docs.python.org/3/library/asyncio.html
+.. _Bayeux: https://docs.cometd.org/current/reference/#_bayeux
+.. _ext: https://docs.cometd.org/current/reference/#_bayeux_ext

README.rst

@@ -1,4 +1,83 @@
-.. include:: DESCRIPTION.rst
+aiocometd
+=========
+
+.. image:: https://badge.fury.io/py/aiocometd.svg
+    :target: https://badge.fury.io/py/aiocometd
+    :alt: PyPI package
+
+.. image:: https://readthedocs.org/projects/aiocometd/badge/?version=latest
+    :target: http://aiocometd.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. image:: https://travis-ci.org/robertmrk/aiocometd.svg?branch=develop
+    :target: https://travis-ci.org/robertmrk/aiocometd
+    :alt: Build status
+
+.. image:: https://coveralls.io/repos/github/robertmrk/aiocometd/badge.svg
+    :target: https://coveralls.io/github/robertmrk/aiocometd
+    :alt: Coverage
+
+.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
+    :target: https://opensource.org/licenses/MIT
+    :alt: MIT license
+
+aiocometd is a CometD_ client built using asyncio_, implementing the Bayeux_
+protocol.
+
+CometD_ is a scalable WebSocket and HTTP based event and message routing bus.
+CometD_ makes use of WebSocket and HTTP push technologies known as Comet_ to
+provide low-latency data from the server to browsers and client applications.
+
+Features
+--------
+
+- Supported transports:
+   - ``long-polling``
+   - ``websocket``
+- Automatic reconnection after network failures
+- Extensions
+
+Usage
+-----
+
+.. code-block:: python
+
+    import asyncio
+
+    from aiocometd import Client
+
+    async def chat():
+        nickname = "John"
+
+        # connect to the server
+        async with Client("http://example.com/cometd") as client:
+
+                # subscribe to channels to receive chat messages and
+                # notifications about new members
+                await client.subscribe("/chat/demo")
+                await client.subscribe("/members/demo")
+
+                # send initial message
+                await client.publish("/chat/demo", {
+                    "user": nickname,
+                    "membership": "join",
+                    "chat": nickname + " has joined"
+                })
+                # add the user to the chat room's members
+                await client.publish("/service/members", {
+                    "user": nickname,
+                    "room": "/chat/demo"
+                })
+
+                # listen for incoming messages
+                async for message in client:
+                    if message["channel"] == "/chat/demo":
+                        data = message["data"]
+                        print(f"{data['user']}: {data['chat']}")
+
+    if __name__ == "__main__":
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(chat())
 
 Install
 -------
@@ -13,4 +92,9 @@ Requirements
 - Python 3.6+
 - aiohttp_
 
-.. include:: docs/source/global.rst
+.. _aiohttp: https://github.com/aio-libs/aiohttp/
+.. _CometD: https://cometd.org/
+.. _Comet: https://en.wikipedia.org/wiki/Comet_(programming)
+.. _asyncio: https://docs.python.org/3/library/asyncio.html
+.. _Bayeux: https://docs.cometd.org/current/reference/#_bayeux
+.. _ext: https://docs.cometd.org/current/reference/#_bayeux_ext

aiocometd/_metadata.py

@@ -3,6 +3,6 @@
 DESCRIPTION = "CometD client for asyncio"
 KEYWORDS = "asyncio aiohttp comet cometd bayeux push streaming"
 URL = "https://github.com/robertmrk/aiocometd"
-VERSION = "0.2.2"
+VERSION = "0.2.3"
 AUTHOR = "Róbert Márki"
 AUTHOR_EMAIL = "gsmiko@gmail.com"

docs/source/changes.rst

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+0.2.3 (2018-04-24)
+------------------
+
+- Fix RST rendering issues
+
 0.2.2 (2018-04-24)
 ------------------