Add async client (based on aiohttp instead of requests) (#41)

Author: amirrpp

Makefile

@@ -0,0 +1,19 @@
+STREAM_KEY ?= NOT_EXIST
+STREAM_SECRET ?= NOT_EXIST
+
+# These targets are not files
+.PHONY: help check test
+
+help: ## Display this help message
+	@echo "Please use \`make <target>\` where <target> is one of"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; \
+	{printf "\033[36m%-40s\033[0m %s\n", $$1, $$2}'
+
+lint:  ## Run linters
+	black --check stream_chat
+	pycodestyle --ignore=E501,E225,W293 stream_chat
+
+test:  ## Run tests
+	STREAM_KEY=$(STREAM_KEY) STREAM_SECRET=$(STREAM_SECRET) python setup.py test
+
+check: lint test  ## Run linters + tests

README.md

@@ -36,27 +36,77 @@ pip install stream-chat
 
 ### Quickstart
 
+#### Sync
+
 ```python
-chat = StreamChat(api_key="STREAM_KEY", api_secret="STREAM_SECRET")
+from stream_chat import StreamChat
+
+
+def main():
+    chat = StreamChat(api_key="STREAM_KEY", api_secret="STREAM_SECRET")
+
+    # add a user
+    chat.update_user({"id": "chuck", "name": "Chuck"})
 
-# add a user
-chat.update_user({"id": "chuck", "name": "Chuck"})
+    # create a channel about kung-fu
+    channel = chat.channel("messaging", "kung-fu")
+    channel.create("chuck")
 
-# create a channel about kung-fu
-channel = chat.channel("messaging", "kung-fu")
-channel.create("chuck")
+    # add a first message to the channel
+    channel.send_message({"text": "AMA about kung-fu"}, "chuck")
 
-# add a first message to the channel
-channel.send_message({"text": "AMA about kung-fu"}, "chuck")
+
+if __name__ == '__main__':
+    main()
+
+```
+
+#### Async
+
+```python
+import asyncio
+from stream_chat import StreamChatAsync
+
+
+async def main():
+    async with StreamChatAsync(api_key="STREAM_KEY", api_secret="STREAM_SECRET") as chat:
+        # add a user
+        await chat.update_user({"id": "chuck", "name": "Chuck"})
+
+        # create a channel about kung-fu
+        channel = chat.channel("messaging", "kung-fu")
+        await channel.create("chuck")
+
+        # add a first message to the channel
+        await channel.send_message({"text": "AMA about kung-fu"}, "chuck")
+
+
+if __name__ == '__main__':
+    loop = asyncio.get_event_loop()
+    try:
+        loop.run_until_complete(main())
+    finally:
+        loop.run_until_complete(loop.shutdown_asyncgens())
+        loop.close()
 
 ```
 
 ### Contributing
 
+Install pytest and pytest-asyncio
+
+```
+pip install pytest
+pip install pytest-asyncio
+```
+
 First, make sure you can run the test suite. Tests are run via py.test
 
 ```bash
-STREAM_KEY=my_api_key STREAM_SECRET=my_api_secret py.test stream_chat/ -v
+export STREAM_KEY=my_api_key
+export STREAM_SECRET=my_api_secret
+
+make test
 ```
 
 Install black and pycodestyle
@@ -66,6 +116,12 @@ pip install black
 pip install pycodestyle
 ```
 
+Run linters
+
+```bash
+make lint
+```
+
 
 ### Releasing a new version
 

setup.py

@@ -3,9 +3,15 @@
 from setuptools import find_packages, setup
 from setuptools.command.test import test as TestCommand
 
-install_requires = ["pycryptodomex>=3.8.1,<4", "requests>=2.22.0,<3", "pyjwt==1.7.1"]
+install_requires = [
+    "pycryptodomex>=3.8.1,<4",
+    "requests>=2.22.0,<3",
+    "aiohttp>=3.6",
+    "aiofile>=3.1,<4",
+    "pyjwt==1.7.1",
+]
 long_description = open("README.md", "r").read()
-tests_require = ["pytest"]
+tests_require = ["pytest", "pytest-asyncio"]
 
 about = {}
 with open("stream_chat/__pkg__.py") as fp:

stream_chat/__init__.py

@@ -1 +1,2 @@
 from .client import StreamChat
+from .async_chat import StreamChatAsync

stream_chat/async_chat/__init__.py

@@ -0,0 +1 @@
+from .client import StreamChatAsync