feature request : allow to provide a client_manager #10

.github/workflows/publish.yml

@@ -33,5 +33,5 @@ jobs:
         TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
       run: |
         python setup.py sdist bdist_wheel
-        twine upload dist/*
+        twine upload --skip-existing dist/*
 

CONTRIBUTORS.md

@@ -0,0 +1,6 @@
+# Contributors
+
+* [Matthew D. Scholefield](https://github.com/MatthewScholefield) - Added cors allowed origins for AsyncServer [#7](https://github.com/pyropy/fastapi-socketio/pull/7)
+* [Aaron Tolman](https://github.com/tolmanam) - Reported issue with broken pip download [#5](https://github.com/pyropy/fastapi-socketio/issues/5)
+* [Khiem Doan](https://github.com/khiemdoan) - Helped with cleaning up old unused dependencies[#5](https://github.com/pyropy/fastapi-socketio/issues/15)
+* [Artem Kolomatskiy](https://github.com/Roxe322) - Fixed invalid usage of enter_room and leave_room[#24](https://github.com/pyropy/fastapi-socketio/issues/24)

Pipfile

@@ -8,15 +8,22 @@ jedi = "*"
 neovim = "*"
 
 [packages]
-fastapi = "==0.61.1"
-netifaces = "==0.10.6"
-pydantic = "==1.6.1"
-starlette = "==0.13.6"
-python-socketio = "==4.6.0"
+fastapi = ">=0.61.1"
+netifaces = ">=0.10.6"
+pydantic = ">=1.6.1"
+starlette = ">=0.13.6"
+python-socketio = ">=4.6.0"
 python-engineio = "*"
 
 [test]
-pytest = "==6.0.1"
+pytest = ">=6.0.1"
+fastapi = ">=0.61.1"
+netifaces = ">=0.10.6"
+pydantic = ">=1.6.1"
+starlette = ">=0.13.6"
+python-socketio = ">=4.6.0"
+python-engineio = "*"
+
 
 [requires]
 python_version = "3.8"

README.md

@@ -49,6 +49,34 @@ async def handle_leave(sid, *args, **kwargs):
 
 ```
 
+### Working with distributed applications
+
+When working with distributed applications, it is often necessary to access the functionality of the Socket.IO from multiple processes. As a solution to the above problems, the Socket.IO server can be configured to connect to a message queue such as `Redis` or `RabbitMQ`, to communicate with other related Socket.IO servers or auxiliary workers.
+
+Refer this link for more details https://python-socketio.readthedocs.io/en/latest/server.html#using-a-message-queue
+
+```python
+# app.py
+import socketio
+
+from fastapi import FastAPI
+from fastapi_socketio import SocketManager
+
+app = FastAPI()
+redis_manager = socketio.AsyncRedisManager('redis://')
+
+socket_manager = SocketManager(app=app, client_manager=redis_manager)
+```
+
+### Emitting from external process
+
+```python
+# emitter.py
+import socketio
+
+external_sio = socketio.RedisManager('redis://', write_only=True) # connect to the redis queue as an external process
+external_sio.emit('my event', data={'foo': 'bar'}, room='my room') # emit an event
+```
 ## Development
 
 To contribute to this library, first checkout the code. Then create a new virtual environment:
@@ -68,3 +96,18 @@ Now install the dependencies and tests:
 To run the tests:
 
     pytest
+
+
+## Run example
+
+To run the examples simply run:
+
+```bash
+PYTHONPATH=. python examples/app.py
+```
+
+Before running example make sure you have all dependencies installed.
+
+## Contributors
+
+For list of contributors please reefer to CONTRIBUTORS.md file in this repository.

examples/app.py

@@ -25,4 +25,4 @@ async def test(sid, *args, **kwargs):
 
     import uvicorn
 
-    uvicorn.run("examples:app", host='0.0.0.0', port=8000, reload=True, debug=False)
+    uvicorn.run("examples.app:app", host='0.0.0.0', port=8000, reload=True, debug=False)

fastapi_socketio/__init__.py

@@ -1,4 +1 @@
-from .socket_manager import SocketManager
-
-def example_function():
-    return 1 + 1
+from .socket_manager import SocketManager

fastapi_socketio/socket_manager.py

@@ -1,4 +1,8 @@
+from typing import Union
+
 import socketio
+
+from socketio.asyncio_manager import AsyncManager
 from fastapi import FastAPI
 
 
@@ -21,10 +25,13 @@ def __init__(
         app: FastAPI,
         mount_location: str = "/ws",
         socketio_path: str = "socket.io",
-        cors_allowed_origins: list = [],
+        cors_allowed_origins: Union[str, list] = '*',
+        async_mode: str = "asgi",
+        client_manager=None
     ) -> None:
         # TODO: Change Cors policy based on fastapi cors Middleware
-        self._sio = socketio.AsyncServer(async_mode="asgi", cors_allowed_origins="*")
+        self._sio = socketio.AsyncServer(
+            async_mode=async_mode, cors_allowed_origins=cors_allowed_origins, client_manager=client_manager)
         self._app = socketio.ASGIApp(
             socketio_server=self._sio, socketio_path=socketio_path
         )
@@ -86,3 +93,15 @@ def start_background_task(self):
     @property
     def sleep(self):
         return self._sio.sleep
+
+    @property
+    def enter_room(self):
+        return self._sio.enter_room
+
+    @property
+    def leave_room(self):
+        return self._sio.leave_room
+
+    @property
+    def rooms(self):
+        return self._sio.rooms

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup
 import os
 
-VERSION = "0.1"
+VERSION = "0.0.9"
 
 
 def get_long_description():
@@ -28,7 +28,10 @@ def get_long_description():
     license="Apache License, Version 2.0",
     version=VERSION,
     packages=["fastapi_socketio"],
-    install_requires=[],
+    install_requires=[
+        "fastapi>=0.61.1",
+        "python-socketio>=4.6.0",
+    ],
     extras_require={"test": ["pytest"]},
     tests_require=["fastapi-socketio[test]"],
 )

tests/test_fastapi_socketio.py

@@ -1,5 +1,2 @@
-from fastapi_socketio import example_function
-
-
-def test_example_function():
-    assert example_function() == 2
+def test_dummy():
+    assert True