Add readme for room manager (#16)

* Add readme for room manager

* Update pyright

* Fix imports in example

* Requested changes

Author: Karolk99

examples/README.md

@@ -0,0 +1,25 @@
+# Fishjam Room Manager
+
+## Running (in dev mode)
+All available options are defined in [arguments.py](room_manager/arguments.py).
+
+```console
+poetry install
+poetry run room_manager # Room Manager has to be started in the project root directory
+```
+
+## How does it work?
+
+Fishjam Room Manager serves the purpose of a simple backend that allows users to create and/or join Fishjam rooms.
+Users must provide a room name and their username to obtain an authentication token that allows them to connect to a Fishjam instance.
+Room Manager manages the room names and user names by itself by keeping the mappings in memory.
+
+As of now, it exposes 2 endpoints.
+
+### '/api/rooms/:roomName/users/:username'
+
+Returns authentication token for a username in a given room. If the user doesn't exist yet, it will be created.
+
+### '/api/rooms/webhook'
+
+Exposes a webhook endpoint to allow the Fishjam instance to send notifications to the Room Manager.

examples/room-manager/__init__.py renamed to examples/room_manager/__init__.py

@@ -4,7 +4,7 @@
 def parse_arguments():
     parser = argparse.ArgumentParser(description="Room Manager")
 
-    parser.add_argument("--port", type=int, default=5002)
+    parser.add_argument("--port", type=int, default=5000)
     parser.add_argument("--peerless_purge_timeout", type=int, default=None)
     parser.add_argument("--webhook_url", type=str, default=None)
     parser.add_argument("--enable_simulcast", type=str, default=True)

examples/room-manager/arguments.py renamed to examples/room_manager/arguments.py

@@ -17,4 +17,4 @@
 
     setup_routes(app, room_service)
 
-    app.run()
+    app.run(port=args.port)

examples/room-manager/main.py renamed to examples/room_manager/main.py

@@ -0,0 +1,3 @@
+[virtualenvs]
+in-project = true
+create = true

examples/room-manager/room_service.py renamed to examples/room_manager/room_service.py

@@ -1,3 +1,4 @@
+import os
 import shutil
 import subprocess
 import sys
@@ -57,8 +58,8 @@ def generate_docs():
     check_exit_code(
         "pdoc \
     --include-undocumented \
-    --favicon https://logo.swmansion.com/membrane/\?width\=100\&variant\=signetDark\
-    --logo https://logo.swmansion.com/membrane/\?width\=70\&variant\=signetDark\
+    --favicon https://logo.swmansion.com/membrane/\\?width\\=100\\&variant\\=signetDark\
+    --logo https://logo.swmansion.com/membrane/\\?width\\=70\\&variant\\=signetDark\
     -t templates/doc \
     -o doc \
     fishjam"
@@ -90,3 +91,17 @@ def update_client():
             --config openapi-python-client-config.yaml \
             --custom-template-path=templates/openapi"
     )
+
+
+def start_room_manager():
+    current_path = os.getcwd()
+    current_folder = os.path.basename(current_path)
+
+    if current_folder != "python-server-sdk":
+        raise RuntimeError(
+            "Room Manager has to be started from the `python-server-sdk` directory."
+        )
+
+    subprocess.run(
+        ["python", "-m", "examples.room_manager.main"] + sys.argv[1:], check=False
+    )

examples/room-manager/routes.py renamed to examples/room_manager/routes.py

@@ -48,6 +48,7 @@ lint = "poetry_scripts:run_linter"
 fix_lint = "poetry_scripts:run_linter_fix"
 generate_docs = "poetry_scripts:generate_docs"
 update_client = "poetry_scripts:update_client"
+room_manager = "poetry_scripts:start_room_manager"
 
 [tool.ruff]
 select = ["F", "I"]
@@ -65,7 +66,7 @@ markers = [
 ]
 
 [tool.pyright]
-exclude = ["**/venv", "**/__pycache__", ".pytest_cache", ".ruff_cache", "lib", "fishjam/_openapi_client", "tests"]
+exclude = ["**/.venv", "**/__pycache__", ".pytest_cache", ".ruff_cache", "lib", "fishjam/_openapi_client", "tests"]
 typeCheckingMode = "basic"
-venv = "venv"
+venv = ".venv"
 venvPath = "."