feat: add type hints and mypy

Author: peterdeme

.github/workflows/ci.yml

@@ -2,26 +2,26 @@ name: build
 on:
   push:
     branches:
-      - 'master'
+      - "master"
   pull_request:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref }}
+  cancel-in-progress: true
+
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 1
       matrix:
-        python: [3.6, 3.7, 3.8, 3.9, '3.10']
+        python: [3.6, 3.7, 3.8, 3.9, "3.10"]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python }}
 
-      - name: Add pip bin to PATH
-        run: |
-          echo "/home/runner/.local/bin" >> $GITHUB_PATH
-
       - name: Install deps with ${{ matrix.python }}
         run: pip install ".[test, ci]"
 
@@ -33,6 +33,5 @@ jobs:
         env:
           STREAM_KEY: ${{ secrets.STREAM_KEY }}
           STREAM_SECRET: ${{ secrets.STREAM_SECRET }}
-        run: |
-          python setup.py install
-          make test
+          PYTHONPATH: ${{ github.workspace }}
+        run: make test

.github/workflows/reviewdog.yml

@@ -0,0 +1,29 @@
+name: reviewdog
+on:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  reviewdog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: reviewdog/action-setup@v1
+        with:
+          reviewdog_version: latest
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+
+      - name: Install deps
+        run: pip install ".[ci]"
+
+      - name: Reviewdog
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: make reviewdog

.gitignore

@@ -22,6 +22,7 @@ var/
 .installed.cfg
 *.egg
 include/
+.DS_Store
 
 # Installer logs
 pip-log.txt
@@ -42,6 +43,7 @@ coverage.xml
 .mr.developer.cfg
 .project
 .pydevproject
+.coverage*
 
 # Rope
 .ropeproject
@@ -62,6 +64,7 @@ pip-selfcheck.json
 .idea
 .vscode
 *,cover
+.mypy_cache
 .eggs
 .env
 .envrc

MANIFEST.in

@@ -1 +1,2 @@
-include README.md
+include README.md
+include stream_chat/py.typed

Makefile

@@ -11,12 +11,18 @@ help: ## Display this help message
 
 lint:  ## Run linters
 	black --check stream_chat
-	flake8 --ignore=E501,E225,W293,W503,F401 stream_chat
+	flake8 --ignore=E501,W503 stream_chat
+	mypy stream_chat
 
 lint-fix:
 	black stream_chat
 
 test:  ## Run tests
-	STREAM_KEY=$(STREAM_KEY) STREAM_SECRET=$(STREAM_SECRET) python setup.py test
+	STREAM_KEY=$(STREAM_KEY) STREAM_SECRET=$(STREAM_SECRET) pytest --cov=stream_chat --cov-report=xml stream_chat/tests
 
 check: lint test  ## Run linters + tests
+
+reviewdog:
+	black --check --diff --quiet stream_chat | reviewdog -f=diff -f.diff.strip=0 -filter-mode="diff_context" -name=black -reporter=github-pr-review
+	flake8 --ignore=E501,W503 stream_chat | reviewdog -f=flake8 -name=flake8 -reporter=github-pr-review
+	mypy --show-column-numbers --show-absolute-path stream_chat | reviewdog -efm="%f:%l:%c: %t%*[^:]: %m" -name=mypy -reporter=github-pr-review

README.md

@@ -1,6 +1,6 @@
 # stream-chat-python
 
-[![build](https://github.com/GetStream/stream-chat-python/workflows/build/badge.svg)](https://github.com/GetStream/stream-chat-python/actions) [![PyPI version](https://badge.fury.io/py/stream-chat.svg)](http://badge.fury.io/py/stream-chat) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/stream-chat.svg)
+[![build](https://github.com/GetStream/stream-chat-python/workflows/build/badge.svg)](https://github.com/GetStream/stream-chat-python/actions) [![PyPI version](https://badge.fury.io/py/stream-chat.svg)](http://badge.fury.io/py/stream-chat) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/stream-chat.svg) [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 
 the official Python API client for [Stream chat](https://getstream.io/chat/) a service for building chat applications.
 
@@ -37,6 +37,8 @@ pip install stream-chat
 
 ### Quickstart
 
+> :bulb: The library is almost 100% typed. Feel free to enable [mypy](https://github.com/python/mypy) for our library. We will introduce more improvements in the future in this area.
+
 #### Sync
 
 ```python
@@ -125,7 +127,7 @@ In order to release new version you need to be a maintainer on Pypi.
 - Update the version on setup.py
 - Commit and push to Github
 - Create a new tag for the version (eg. `v2.9.0`)
-- Create a new dist with python `python setup.py sdist`
-- Upload the new distributable with twine `twine upload dist/stream-chat-VERSION-NAME.tar.gz`
+- Create a new dist with python `python setup.py sdist bdist_wheel`
+- Upload the new distributable with twine `twine upload dist/*`
 
 If unsure you can also test using the Pypi test servers `twine upload --repository-url https://test.pypi.org/legacy/ dist/stream-chat-VERSION-NAME.tar.gz`

pyproject.toml

@@ -23,3 +23,13 @@ exclude = '''
   | dist
 )/
 '''
+
+[tool.mypy]
+disallow_untyped_defs = true
+disallow_untyped_calls = true
+check_untyped_defs = true
+warn_unused_configs = true
+
+[[tool.mypy.overrides]]
+module = "stream_chat.tests.*"
+ignore_errors = true

setup.py

@@ -1,65 +1,51 @@
-import sys
-
 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",
-    "chardet>=2.0.0,<4",
     "aiodns>=2.0.0",
     "aiohttp>=3.6.0,<4",
     "aiofile>=3.1,<4",
     "pyjwt>=2.0.0,<3",
+    "typing_extensions; python_version < '3.8'",
 ]
-long_description = open("README.md", "r").read()
 tests_require = ["pytest", "pytest-asyncio"]
-ci_require = ["black", "flake8", "pytest-cov"]
+ci_require = [
+    "black",
+    "flake8",
+    "flake8-bugbear",
+    "pytest-cov",
+    "mypy",
+    "types-requests",
+]
+
+with open("README.md", "r") as f:
+    long_description = f.read()
 
 about = {}
+
 with open("stream_chat/__pkg__.py") as fp:
     exec(fp.read(), about)
 
-
-class PyTest(TestCommand):
-    def finalize_options(self):
-        TestCommand.finalize_options(self)
-        self.test_args = []
-        self.test_suite = True
-
-    def run_tests(self):
-        # import here, cause outside the eggs aren't loaded
-        import pytest
-
-        pytest_cmd = ["stream_chat/", "-v"]
-
-        try:
-            pytest_cmd += [
-                "--cov=stream_chat/",
-                "--cov-report=xml",
-            ]
-        except ImportError:
-            pass
-
-        errno = pytest.main(pytest_cmd)
-        sys.exit(errno)
-
-
 setup(
     name="stream-chat",
-    cmdclass={"test": PyTest},
     version=about["__version__"],
     author=about["__maintainer__"],
     author_email=about["__email__"],
-    url="http://github.com/GetStream/chat-py",
+    url="https://github.com/GetStream/stream-chat-python",
+    project_urls={
+        "Bug Tracker": "https://github.com/GetStream/stream-chat-python/issues",
+        "Documentation": "https://getstream.io/activity-feeds/docs/python/?language=python",
+        "Release Notes": "https://github.com/GetStream/stream-chat-python/releases/tag/v{}".format(
+            about["__version__"]
+        ),
+    },
     description="Client for Stream Chat.",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    packages=find_packages(),
+    packages=find_packages(exclude=["*tests*"]),
     zip_safe=False,
     install_requires=install_requires,
     extras_require={"test": tests_require, "ci": ci_require},
-    tests_require=tests_require,
     include_package_data=True,
     python_requires=">=3.6",
     classifiers=[

stream_chat/__init__.py

@@ -1,2 +1,4 @@
 from .client import StreamChat
 from .async_chat import StreamChatAsync
+
+__all__ = ["StreamChat", "StreamChatAsync"]

stream_chat/__pkg__.py

@@ -1,5 +1,5 @@
 __author__ = "Tommaso Barbugli"
-__copyright__ = "Copyright 2019-2021, Stream.io, Inc"
+__copyright__ = "Copyright 2019-2022, Stream.io, Inc"
 __version__ = "3.16.0"
 __maintainer__ = "Tommaso Barbugli"
 __email__ = "[email protected]"

stream_chat/async_chat/__init__.py

@@ -1 +1,3 @@
 from .client import StreamChatAsync
+
+__all__ = ["StreamChatAsync"]