comment suggestions

Author: Gawor270

examples/selective_subscription/.env.example

@@ -0,0 +1,3 @@
+# Your Fishjam envs, which you can get at https://fishjam.io/app
+FISHJAM_ID="your-fishjam-id"
+FISHJAM_MANAGEMENT_TOKEN="your-management-token"

examples/selective_subscription/README.md

@@ -8,19 +8,23 @@ Demo application showing selective subscription functionality with [Fishjam](htt
 - [uv](https://docs.astral.sh/uv/) package manager
 - Fishjam credentials ([get them here](https://fishjam.io/app))
 
+> [!IMPORTANT]
+> All commands should be run from the `examples/selective_subscription` directory
+
 ## Quick Start
 
 1. Install dependencies (in the `examples/selective_subscription` directory):
    ```bash
-   cd examples/selective_subscription
    uv sync
    ```
 
+To run the app, first copy [`.env.example`](./.env.example) to `.env` and populate your environment variables.
+
+Once you have populated `.env`, you can run the demo with
+
 2. Run the server:
    ```bash
-   FISHJAM_ID=<your-id> \
-   FISHJAM_MANAGEMENT_TOKEN=<your-token> \
-   uv run main.py
+   uv run ./main.py
    ```
 
 3. Open http://localhost:8000 in your browser

examples/selective_subscription/pyproject.toml

@@ -8,14 +8,8 @@ dependencies = [
     "starlette>=0.35.0",
     "uvicorn>=0.25.0",
     "fishjam-server-sdk",
+    "python-dotenv",
 ]
 
 [tool.uv.sources]
-fishjam-server-sdk = { workspace = true }
-
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[tool.hatch.build.targets.wheel]
-packages = ["selective_subscription"]
+fishjam-server-sdk = { workspace = true }

examples/selective_subscription/selective_subscription/app.py

@@ -52,7 +52,7 @@ async def subscribe_peer(request: Request) -> Response:
                 {"error": "peer_id and target_peer_id are required"}, status_code=400
             )
 
-        room_service.subscibe_peer(peer_id, target_peer_id)
+        room_service.subscribe_peer(peer_id, target_peer_id)
         return JSONResponse({"status": "subscribed"})
     except Exception as e:
         return JSONResponse({"error": str(e)}, status_code=500)

examples/selective_subscription/selective_subscription/config.py

@@ -1,5 +1,9 @@
 import os
 
+import dotenv
+
+dotenv.load_dotenv()
+
 FISHJAM_ID = os.environ["FISHJAM_ID"]
 FISHJAM_TOKEN = os.environ["FISHJAM_MANAGEMENT_TOKEN"]
 HOST = os.getenv("HOST", "localhost")

examples/selective_subscription/selective_subscription/room_service.py

@@ -29,7 +29,7 @@ def create_peer(self) -> tuple[Peer, str]:
         peer, token = self.fishjam.create_peer(room.id, options)
         return peer, token
 
-    def subscibe_peer(self, peer_id: str, target_peer_id: str):
+    def subscribe_peer(self, peer_id: str, target_peer_id: str):
         room = self.get_or_create_room()
         self.fishjam.subscribe_peer(room.id, peer_id, target_peer_id)
 

fishjam/api/_fishjam_client.py

@@ -264,7 +264,7 @@ def create_livestream_streamer_token(self, room_id: str) -> str:
         return response.token
 
     def subscribe_peer(self, room_id: str, peer_id: str, target_peer_id: str):
-        "" "Subscribe a peer to all tracks of another peer." ""
+        """Subscribe a peer to all tracks of another peer."""
 
         self._request(
             room_subscribe_peer,
@@ -274,7 +274,7 @@ def subscribe_peer(self, room_id: str, peer_id: str, target_peer_id: str):
         )
 
     def subscribe_tracks(self, room_id: str, peer_id: str, track_ids: list[str]):
-        "" "Subscribe a peer to specific tracks of another peer." ""
+        """Subscribe a peer to specific tracks of another peer."""
 
         self._request(
             room_subscribe_tracks,

pyproject.toml

@@ -15,8 +15,6 @@ dependencies = [
     "httpx>=0.28.0,<0.29.0",
     "attrs>=21.3.0",
     "flask-cors>=6.0.1,<7",
-    "uvicorn>=0.35.0",
-    "starlette>=0.46.2",
 ]
 
 [project.urls]