support token refresh, future corner cases

.github/workflows/test.yml

@@ -32,3 +32,8 @@ jobs:
     - name: Run tests
       run: |
         python -m unittest discover -s tests
+
+    - name: Run linter
+      run: |
+        pip install flake8
+        flake8 centrifuge --max-line-length 120 --exclude centrifuge/protocol/client_pb2.py

Makefile

@@ -1,4 +1,14 @@
-.PHONY: proto
+.PHONY: proto test lint
+
+dev:
+	pip install -r requirements.txt
+	pip install -r requirements-dev.txt
 
 proto:
 	protoc --python_out=centrifuge/protocol client.proto
+
+test:
+	python -m unittest discover -s tests
+
+lint:
+	flake8 centrifuge --max-line-length 120 --exclude centrifuge/protocol/client_pb2.py

README.md

@@ -2,6 +2,24 @@
 
 This is a WebSocket SDK for [Centrifugo](https://github.com/centrifugal/centrifugo) server (and any [Centrifuge-based](https://github.com/centrifugal/centrifuge) server) on top of Python asyncio library.
 
+Before starting to work with this library check out [Centrifugo client SDK API specification](https://centrifugal.dev/docs/transports/client_api) as it contains common information about Centrifugal real-time SDK behavior.
+
+The features implemented by this SDK can be found in [SDK feature matrix](https://centrifugal.dev/docs/transports/client_sdk#sdk-feature-matrix).
+
+## Install
+
+```
+pip install centrifuge-python
+```
+
+Then in your code:
+
+```
+from centrifuge import Client
+```
+
+See [example code](https://github.com/centrifugal/centrifuge-python/blob/master/example.py) and [how to run it](#run-example) locally.
+
 ## Run tests
 
 To run tests first start Centrifugo server:

centrifuge/__init__.py

@@ -1,4 +1,31 @@
-from .client import *
-from .exceptions import *
-from .contexts import *
-from .types import *
+from .client import Client, Subscription, ClientState, SubscriptionState
+from .exceptions import CentrifugeException, Timeout, ClientDisconnected, \
+    SubscriptionUnsubscribed, DuplicateSubscription, ReplyError, Unauthorized
+from .contexts import SubscriptionTokenContext, ConnectionTokenContext, \
+    SubscribingContext, SubscribedContext, UnsubscribedContext, \
+    PublicationContext, JoinContext, LeaveContext, \
+    ErrorContext, DisconnectedContext, ConnectedContext, ConnectingContext, \
+    ServerSubscribedContext, ServerSubscribingContext, ServerUnsubscribedContext, \
+    ServerPublicationContext, ServerJoinContext, ServerLeaveContext, \
+    SubscriptionErrorContext
+from .types import JSON, BytesOrJSON, StreamPosition, ClientInfo, Publication, PublishResult, \
+    HistoryResult, PresenceResult, PresenceStatsResult, RpcResult
+
+
+__all__ = [
+    Client, Subscription, ClientState, SubscriptionState,
+
+    CentrifugeException, Timeout, ClientDisconnected, SubscriptionUnsubscribed,
+    DuplicateSubscription, ReplyError, Unauthorized,
+
+    SubscriptionTokenContext, ConnectionTokenContext,
+    SubscribingContext, SubscribedContext, UnsubscribedContext,
+    PublicationContext, JoinContext, LeaveContext,
+    ErrorContext, DisconnectedContext, ConnectedContext, ConnectingContext,
+    ServerSubscribedContext, ServerSubscribingContext, ServerUnsubscribedContext,
+    ServerPublicationContext, ServerJoinContext, ServerLeaveContext,
+    SubscriptionErrorContext,
+
+    JSON, BytesOrJSON, StreamPosition, ClientInfo, Publication, PublishResult,
+    HistoryResult, PresenceResult, PresenceStatsResult, RpcResult
+]