fishjam-server-sdk 0.5.0__tar.gz

fishjam_server_sdk-0.5.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.1
+Name: fishjam-server-sdk
+Version: 0.5.0
+Summary: Python server SDK for the Fishjam media server
+Home-page: https://github.com/fishjam-dev/python-server-sdk
+License: Apache-2.0
+Author: Fishjam Team
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: aenum (>=3.1.15,<4.0.0)
+Requires-Dist: attrs (>=21.3.0)
+Requires-Dist: betterproto (==2.0.0b6)
+Requires-Dist: httpx (>=0.20.0,<0.26.0)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: urllib3 (>=1.25.3,<2)
+Requires-Dist: websockets (>=11.0.3,<12.0.0)
+Project-URL: Documentation, https://fishjam-dev.github.io/python-server-sdk/fishjam
+Description-Content-Type: text/markdown
+
+# Fishjam Python Server SDK
+
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/fishjam-dev/python-server-sdk/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/fishjam-dev/python-server-sdk/tree/main)
+
+Python server SDK for the [Fishjam Media Server](https://github.com/fishjam-dev/fishjam).
+
+Read the docs [here](https://fishjam-dev.github.io/python-server-sdk)
+
+## Installation
+
+```
+pip install fishjam-server-sdk
+```
+
+## Usage
+
+The SDK exports two main classes for interacting with Fishjam server:
+`RoomApi` and `Notifier`.
+
+`RoomApi` wraps http REST api calls, while `Notifier` is responsible for receiving real-time updates from the server.
+
+#### RoomApi
+
+Create a `RoomApi` instance, providing the fishjam server address and api token
+
+```python
+from fishjam import RoomApi
+
+room_api = RoomApi(server_address="localhost:5002", server_api_token="development")
+```
+
+You can use it to interact with Fishjam, manage rooms, peers and components
+
+```python
+# Create a room
+fishjam_address, room = room_api.create_room(video_codec="h264", webhook_url="http://localhost:5000/webhook")
+# '127.0.0.1:5002', Room(components=[], config=RoomConfig(max_peers=None, video_codec=<RoomConfigVideoCodec.H264: 'h264'>, webhook_url='http://localhost:5000/webhook'), id='1d905478-ccfc-44d6-a6e7-8ccb1b38d955', peers=[])
+
+# Add peer to the room
+from fishjam import PeerOptionsWebRTC
+
+peer_token, peer_webrtc = room_api.add_peer(room.id, options=PeerOptionsWebRTC())
+# 'M8TUGhj-L11KpyG-2zBPIo', Peer(id='b1232c7e-c969-4450-acdf-ea24f3cdd7f6', status=<PeerStatus.DISCONNECTED: 'disconnected'>, type='webrtc')
+
+# Add component to the room
+from fishjam import ComponentOptionsHLS
+
+component_hls = room_api.add_component(room.id, options=ComponentOptionsHLS())
+# ComponentHLS(id='5f062447-a9f7-45ed-8d1b-511f77dc78ae', properties=ComponentPropertiesHLS(low_latency=False, persistent=False, playable=False, subscribe_mode=<ComponentPropertiesHLSSubscribeMode.AUTO: 'auto'>, target_window_duration=None), type='hls')
+```
+
+All methods in `RoomApi` may raise one of the exceptions deriving from `fishjam.errors.HTTPError`. They are defined in `fishjam.errors`.
+
+#### Notifier
+
+Notifier allows for receiving real-time updates from the Fishjam Server.
+
+You can read more about notifications in the [Fishjam Docs](https://fishjam-dev.github.io/fishjam-docs/next/getting_started/notifications).
+
+Create `Notifier` instance
+```python
+from fishjam import Notifier
+
+notifier = Notifier(server_address='localhost:5002', server_api_token='development')
+```
+
+Then define handlers for incoming messages
+```python
+@notifier.on_server_notification
+def handle_notification(server_notification):
+    print(f'Received a notification: {server_notification}')
+
+@notifier.on_metrics
+def handle_metrics(metrics_report):
+    print(f'Received WebRTC metrics: {metrics_report}')
+```
+
+After that you can start the notifier
+```python
+async def test_notifier():
+    notifier_task = asyncio.create_task(notifier.connect())
+
+    # Wait for notifier to be ready to receive messages
+    await notifier.wait_ready()
+
+    # Create a room to trigger a server notification
+    room_api = RoomApi()
+    room_api.create_room()
+
+    await notifier_task
+
+asyncio.run(test_notifier())
+
+# Received a notification: ServerMessageRoomCreated(room_id='69a3fd1a-6a4d-47bc-ae54-0c72b0d05e29')
+# Received WebRTC metrics: ServerMessageMetricsReport(metrics='{}')
+```
+
+#### Cluster of Fishjams
+
+The cluster of fishjams has got embedded load balancer, which means that a new room will be created on fishjam with the least usage. At the moment to modify this specific room you must communicate with the fishjam on which this room was created.
+
+```python
+room_api = RoomApi(server_address='localhost:5002')
+
+# Create a room to trigger a server notification with h264 as a codec,
+# that allow to use HLS.
+address, room = room_api.create_room(video_codec="h264")
+
+# Create new room api with returned fishjam address as a room could be
+# created on a different fishjam instance
+# (if you communicate with a cluster of fishjams)
+new_room_api = RoomApi(server_address=address)
+
+# Add HLS component with manual subscribe mode, we use here `new_room_api` as we are sure that this API refers to the fishjam on which this room was created.
+_hls_component = new_room_api.add_component(
+    room.id,
+    ComponentOptionsHLS(subscribe_mode=ComponentOptionsHLSSubscribeMode.MANUAL),
+)
+```
+
+## Testing
+
+You can test the SDK by running
+```console
+poetry run ci_test
+```
+
+In local development you can use
+```console
+poetry run local_test
+```
+
+## Format & Lint
+You can format code by running
+```console
+poetry run format
+```
+
+You can check linter by running
+```console
+poetry run lint
+```
+
+## Copyright and License
+
+Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)
+
+[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)
+
+Licensed under the [Apache License, Version 2.0](LICENSE)
+

fishjam_server_sdk-0.5.0/README.md

@@ -0,0 +1,150 @@
+# Fishjam Python Server SDK
+
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/fishjam-dev/python-server-sdk/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/fishjam-dev/python-server-sdk/tree/main)
+
+Python server SDK for the [Fishjam Media Server](https://github.com/fishjam-dev/fishjam).
+
+Read the docs [here](https://fishjam-dev.github.io/python-server-sdk)
+
+## Installation
+
+```
+pip install fishjam-server-sdk
+```
+
+## Usage
+
+The SDK exports two main classes for interacting with Fishjam server:
+`RoomApi` and `Notifier`.
+
+`RoomApi` wraps http REST api calls, while `Notifier` is responsible for receiving real-time updates from the server.
+
+#### RoomApi
+
+Create a `RoomApi` instance, providing the fishjam server address and api token
+
+```python
+from fishjam import RoomApi
+
+room_api = RoomApi(server_address="localhost:5002", server_api_token="development")
+```
+
+You can use it to interact with Fishjam, manage rooms, peers and components
+
+```python
+# Create a room
+fishjam_address, room = room_api.create_room(video_codec="h264", webhook_url="http://localhost:5000/webhook")
+# '127.0.0.1:5002', Room(components=[], config=RoomConfig(max_peers=None, video_codec=<RoomConfigVideoCodec.H264: 'h264'>, webhook_url='http://localhost:5000/webhook'), id='1d905478-ccfc-44d6-a6e7-8ccb1b38d955', peers=[])
+
+# Add peer to the room
+from fishjam import PeerOptionsWebRTC
+
+peer_token, peer_webrtc = room_api.add_peer(room.id, options=PeerOptionsWebRTC())
+# 'M8TUGhj-L11KpyG-2zBPIo', Peer(id='b1232c7e-c969-4450-acdf-ea24f3cdd7f6', status=<PeerStatus.DISCONNECTED: 'disconnected'>, type='webrtc')
+
+# Add component to the room
+from fishjam import ComponentOptionsHLS
+
+component_hls = room_api.add_component(room.id, options=ComponentOptionsHLS())
+# ComponentHLS(id='5f062447-a9f7-45ed-8d1b-511f77dc78ae', properties=ComponentPropertiesHLS(low_latency=False, persistent=False, playable=False, subscribe_mode=<ComponentPropertiesHLSSubscribeMode.AUTO: 'auto'>, target_window_duration=None), type='hls')
+```
+
+All methods in `RoomApi` may raise one of the exceptions deriving from `fishjam.errors.HTTPError`. They are defined in `fishjam.errors`.
+
+#### Notifier
+
+Notifier allows for receiving real-time updates from the Fishjam Server.
+
+You can read more about notifications in the [Fishjam Docs](https://fishjam-dev.github.io/fishjam-docs/next/getting_started/notifications).
+
+Create `Notifier` instance
+```python
+from fishjam import Notifier
+
+notifier = Notifier(server_address='localhost:5002', server_api_token='development')
+```
+
+Then define handlers for incoming messages
+```python
+@notifier.on_server_notification
+def handle_notification(server_notification):
+    print(f'Received a notification: {server_notification}')
+
+@notifier.on_metrics
+def handle_metrics(metrics_report):
+    print(f'Received WebRTC metrics: {metrics_report}')
+```
+
+After that you can start the notifier
+```python
+async def test_notifier():
+    notifier_task = asyncio.create_task(notifier.connect())
+
+    # Wait for notifier to be ready to receive messages
+    await notifier.wait_ready()
+
+    # Create a room to trigger a server notification
+    room_api = RoomApi()
+    room_api.create_room()
+
+    await notifier_task
+
+asyncio.run(test_notifier())
+
+# Received a notification: ServerMessageRoomCreated(room_id='69a3fd1a-6a4d-47bc-ae54-0c72b0d05e29')
+# Received WebRTC metrics: ServerMessageMetricsReport(metrics='{}')
+```
+
+#### Cluster of Fishjams
+
+The cluster of fishjams has got embedded load balancer, which means that a new room will be created on fishjam with the least usage. At the moment to modify this specific room you must communicate with the fishjam on which this room was created.
+
+```python
+room_api = RoomApi(server_address='localhost:5002')
+
+# Create a room to trigger a server notification with h264 as a codec,
+# that allow to use HLS.
+address, room = room_api.create_room(video_codec="h264")
+
+# Create new room api with returned fishjam address as a room could be
+# created on a different fishjam instance
+# (if you communicate with a cluster of fishjams)
+new_room_api = RoomApi(server_address=address)
+
+# Add HLS component with manual subscribe mode, we use here `new_room_api` as we are sure that this API refers to the fishjam on which this room was created.
+_hls_component = new_room_api.add_component(
+    room.id,
+    ComponentOptionsHLS(subscribe_mode=ComponentOptionsHLSSubscribeMode.MANUAL),
+)
+```
+
+## Testing
+
+You can test the SDK by running
+```console
+poetry run ci_test
+```
+
+In local development you can use
+```console
+poetry run local_test
+```
+
+## Format & Lint
+You can format code by running
+```console
+poetry run format
+```
+
+You can check linter by running
+```console
+poetry run lint
+```
+
+## Copyright and License
+
+Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)
+
+[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)
+
+Licensed under the [Apache License, Version 2.0](LICENSE)

fishjam_server_sdk-0.5.0/fishjam/__init__.py

@@ -0,0 +1,85 @@
+"""
+    .. include:: ../README.md
+"""
+
+# pylint: disable=locally-disabled, no-name-in-module, import-error
+
+# Exceptions and Server Messages
+from fishjam import errors, events
+
+# Models
+from fishjam._openapi_client.models import (
+    ComponentFile,
+    ComponentHLS,
+    ComponentOptionsFile,
+    ComponentOptionsHLS,
+    ComponentOptionsHLSSubscribeMode,
+    ComponentOptionsRecording,
+    ComponentOptionsRecordingSubscribeMode,
+    ComponentOptionsRTSP,
+    ComponentOptionsSIP,
+    ComponentPropertiesFile,
+    ComponentPropertiesHLS,
+    ComponentPropertiesHLSSubscribeMode,
+    ComponentPropertiesRecording,
+    ComponentPropertiesRecordingSubscribeMode,
+    ComponentPropertiesRTSP,
+    ComponentPropertiesSIP,
+    ComponentPropertiesSIPSIPCredentials,
+    ComponentRecording,
+    ComponentRTSP,
+    ComponentSIP,
+    Peer,
+    PeerOptionsWebRTC,
+    PeerStatus,
+    Room,
+    RoomConfig,
+    RoomConfigVideoCodec,
+    S3Credentials,
+    SIPCredentials,
+)
+
+# API
+from fishjam._webhook_notifier import receive_binary
+from fishjam._ws_notifier import Notifier
+from fishjam.api._recording_api import RecordingApi
+from fishjam.api._room_api import RoomApi
+
+__all__ = [
+    "RoomApi",
+    "RecordingApi",
+    "Notifier",
+    "receive_binary",
+    "Room",
+    "RoomConfig",
+    "RoomConfigVideoCodec",
+    "Peer",
+    "PeerOptionsWebRTC",
+    "PeerStatus",
+    "ComponentHLS",
+    "ComponentOptionsHLS",
+    "ComponentOptionsHLSSubscribeMode",
+    "ComponentPropertiesHLS",
+    "ComponentPropertiesHLSSubscribeMode",
+    "ComponentSIP",
+    "ComponentOptionsSIP",
+    "ComponentPropertiesSIP",
+    "ComponentPropertiesSIPSIPCredentials",
+    "ComponentFile",
+    "ComponentRTSP",
+    "ComponentOptionsRTSP",
+    "ComponentPropertiesRTSP",
+    "ComponentFile",
+    "ComponentOptionsFile",
+    "ComponentPropertiesFile",
+    "events",
+    "errors",
+    "SIPCredentials",
+    "ComponentRecording",
+    "ComponentOptionsRecording",
+    "ComponentOptionsRecordingSubscribeMode",
+    "ComponentPropertiesRecording",
+    "ComponentPropertiesRecordingSubscribeMode",
+    "S3Credentials",
+]
+__docformat__ = "restructuredtext"

fishjam_server_sdk-0.5.0/fishjam/_openapi_client/__init__.py

@@ -0,0 +1,7 @@
+""" A client library for accessing Fishjam Media Server """
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

fishjam_server_sdk-0.5.0/fishjam/_openapi_client/api/__init__.py

@@ -0,0 +1 @@
+""" Contains methods for accessing the API """

fishjam_server_sdk-0.5.0/fishjam/_openapi_client/api/health/healthcheck.py

@@ -0,0 +1,129 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error import Error
+from ...models.healthcheck_response import HealthcheckResponse
+from ...types import Response
+
+
+def _get_kwargs() -> Dict[str, Any]:
+    return {
+        "method": "get",
+        "url": "/health",
+    }
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Error, HealthcheckResponse]]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = HealthcheckResponse.from_dict(response.json())
+
+        return response_200
+    if response.status_code == HTTPStatus.UNAUTHORIZED:
+        response_401 = Error.from_dict(response.json())
+
+        return response_401
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Error, HealthcheckResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union[Error, HealthcheckResponse]]:
+    """Describes the health of Fishjam
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Error, HealthcheckResponse]]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union[Error, HealthcheckResponse]]:
+    """Describes the health of Fishjam
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Error, HealthcheckResponse]
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union[Error, HealthcheckResponse]]:
+    """Describes the health of Fishjam
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Error, HealthcheckResponse]]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union[Error, HealthcheckResponse]]:
+    """Describes the health of Fishjam
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Error, HealthcheckResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed