Use poetry

.circleci/config.yml

@@ -1,25 +1,22 @@
 version: 2.1
 
-orbs:
-  python: circleci/[email protected]
-
 executors:
- machine_executor_amd64:
-   machine:
-     image: ubuntu-2204:2022.04.2
-   environment:
-     architecture: "amd64"
-     platform: "linux/amd64"
-
+  machine_executor_amd64:
+    machine:
+      image: ubuntu-2204:2022.04.2
+    environment:
+      architecture: "amd64"
+      platform: "linux/amd64"
 
 jobs:
   lint:
-    executor: python/default
+    docker:
+      - image: cimg/python:3.8
     steps:
       - checkout
       - run:
-          name: Install python dependencies
-          command: pip install -r dev-requirements.txt
+          name: Install project dependencies
+          command: poetry install --no-ansi
       - run:
           name: Lint
           command: ./pylint.sh

README.md

@@ -63,11 +63,11 @@ Then define handlers for incoming messages
 ```python
 @notifier.on_server_notification
 def handle_notification(server_notification):
-    print(f'Received a notification: {notification}')
+    print(f'Received a notification: {server_notification}')
 
 @notifier.on_metrics
 def handle_metrics(metrics_report):
-    print(f'Received WebRTC metrics: {metrics_report.metrics}')
+    print(f'Received WebRTC metrics: {metrics_report}')
 ```
 
 After that you can start the notifier

docker-compose-test.yaml

@@ -29,8 +29,11 @@ services:
       - network
 
   test:
-    image: python:3.8-alpine3.18
-    command: sh -c "cd app/ && pip install -r dev-requirements.txt && pytest -s"
+    image: cimg/python:3.8
+    command: sh -c "cd /app && \
+      poetry config virtualenvs.in-project false && \
+      poetry install --no-ansi && \
+      poetry run pytest -s"
     environment:
       DOCKER_TEST: "TRUE"
     volumes:

jellyfish/_room_api.py

@@ -35,6 +35,10 @@ def create_room(
 
         Returns a tuple (`jellyfish_address`, `Room`) - the address of the Jellyfish
         in which the room has been created and the created `Room`
+
+        The returned address may be different from the current `RoomApi` instance.
+        In such case, a new `RoomApi` instance has to be created using the returned address
+        in order to interact with the room.
         '''
         room_config = RoomConfig(maxPeers=max_peers, videoCodec=video_codec)
         resp = self._room_api.create_room(room_config)