Add streaming APIs

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,11 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: FabienLavocat
+---
+
+**Describe the feature request**
+
+[Please describe what you expect from this feature.]

.github/ISSUE_TEMPLATE/report-an-issue.md

@@ -0,0 +1,28 @@
+---
+name: Bug Report
+about: Use this template to report an issue.
+title: ''
+labels: bug
+assignees: FabienLavocat
+---
+
+**Describe the bug**
+
+[A clear and concise description of what the bug is.]
+
+**Expected Behavior**
+
+[Describe the expected behavior of the feature.]
+
+**Minimalistic code (recommended)**
+
+[Please provide a link to a repository showing specifically the issue. It should only have the minimal footprint of your own implementation - something which does not requires any NDA.]
+
+**Specifications**
+
+-   OS: [e.g. Windows, Linux, macOS, ...]
+-   Version:
+    -   _for each libraries : name -> version_
+    -   [e.g. dolbyio-rest-apis-client 1.8.7]
+    -   [e.g. python 3.10]
+    -   [...]

.github/workflows/build-package.yml

@@ -0,0 +1,33 @@
+name: Build Package
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  build-package:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+
+      - name: Prepare environment 🌎
+        run: |
+          # Upgrade pip
+          python3 -m pip install --upgrade pip
+          # Install the requirements
+          python3 -m pip install -r requirements.txt
+
+      - name: Run PyLint 🔧
+        run: |
+          # Run PyLint
+          python3 -m pylint client/src/dolbyio_rest_apis cli/src/dolbyio_rest_apis_cli
+
+      - name: Build the packages 🔧
+        run: |
+          # Build the Python packages
+          python3 client/setup.py sdist bdist_wheel
+          python3 cli/setup.py sdist bdist_wheel

.github/workflows/publish-package-to-pypi.yml

@@ -1,41 +1,38 @@
-name: Build and Deploy
+name: Publish Package
 
 on:
-  push:
   release:
-    types:
-      - created
+    types: [published]
 
 jobs:
-  build-and-deploy:
+  publish-package:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout 🛎️
-      uses: actions/checkout@v3
-      with:
-        persist-credentials: false
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
 
-    - name: Prepare environment 🌎
-      run: |
-        # Upgrade pip
-        python3 -m pip install --upgrade pip
-        # Install the requirements
-        python3 -m pip install -r requirements.txt
+      - name: Prepare environment 🌎
+        run: |
+          # Upgrade pip
+          python3 -m pip install --upgrade pip
+          # Install the requirements
+          python3 -m pip install -r requirements.txt
 
-    - name: Run PyLint 🔧
-      run: |
-        # Run PyLint
-        python3 -m pylint client/src/dolbyio_rest_apis cli/src/dolbyio_rest_apis_cli
+      - name: Run PyLint 🔧
+        run: |
+          # Run PyLint
+          python3 -m pylint client/src/dolbyio_rest_apis cli/src/dolbyio_rest_apis_cli
 
-    - name: Build the packages 🔧
-      run: |
-        # Build the Python packages
-        python3 client/setup.py sdist bdist_wheel
-        python3 cli/setup.py sdist bdist_wheel
+      - name: Build the packages 🔧
+        run: |
+          # Build the Python packages
+          python3 client/setup.py sdist bdist_wheel
+          python3 cli/setup.py sdist bdist_wheel
 
-    - name: Deploy to PyPI 🚀
-      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
-      uses: ./.github/actions/gh-action-pypi-publish-1.6.4
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
+      - name: Deploy to PyPI 🚀
+        uses: ./.github/actions/gh-action-pypi-publish-1.6.4
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -1,7 +1,12 @@
-# Dolby.io REST APIs
+[![Build Package](https://github.com/DolbyIO/dolbyio-rest-apis-client-python/actions/workflows/build-package.yml/badge.svg)](https://github.com/DolbyIO/dolbyio-rest-apis-client-python/actions/workflows/build-package.yml)
+[![Publish Package](https://github.com/DolbyIO/dolbyio-rest-apis-client-python/actions/workflows/publish-package-to-pypi.yml/badge.svg)](https://github.com/DolbyIO/dolbyio-rest-apis-client-python/actions/workflows/publish-package-to-pypi.yml)
+![PyPI](https://img.shields.io/pypi/v/dolbyio-rest-apis)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dolbyio-rest-apis)
+[![License](https://img.shields.io/github/license/DolbyIO/dolbyio-rest-apis-client-python)](LICENSE)
 
-This repo contains projects for the dolby.io REST [Communications](https://docs.dolby.io/communications-apis/reference/authentication-api) and [Media](https://docs.dolby.io/media-processing/reference/media-enhance-overview) APIs.
-- Command Line Interface utility.
+# Dolby.io REST APIs Client for Python
+
+Python wrapper for the dolby.io REST [Communications](https://docs.dolby.io/communications-apis/reference/authentication-api), [Streaming](https://docs.dolby.io/streaming-apis/reference) and [Media](https://docs.dolby.io/media-processing/reference/media-enhance-overview) APIs. It also contains a Command Line Interface utility.
 
 ## Build the builder
 

cli/README.md

@@ -1,4 +1,4 @@
-# Dolby.io REST APIs CLI
+# Dolby.io REST APIs Client for Python - CLI
 
 Command Line Interface utility for the dolby.io REST [Communications](https://docs.dolby.io/communications-apis/reference/authentication-api) and [Media](https://docs.dolby.io/media-processing/reference/media-enhance-overview) APIs.
 

client/README.md

@@ -1,6 +1,6 @@
-# Dolby.io REST APIs
+# Dolby.io REST APIs Client for Python
 
-Python wrapper for the dolby.io REST [Communications](https://docs.dolby.io/communications-apis/reference/authentication-api) and [Media](https://docs.dolby.io/media-processing/reference/media-enhance-overview) APIs. All the functions are using the async pattern.
+Python wrapper for the dolby.io REST [Communications](https://docs.dolby.io/communications-apis/reference/authentication-api), [Streaming](https://docs.dolby.io/streaming-apis/reference) and [Media](https://docs.dolby.io/media-processing/reference/media-enhance-overview) APIs.
 
 ## Install this project
 
@@ -107,6 +107,43 @@ conf = loop.run_until_complete(task)
 print(f"Conference created: {conf.id}")
 ```
 
+## Real-time Streaming Examples
+
+### Create a publish token
+
+```python
+import asyncio
+from dolbyio_rest_apis.streaming import publish_token
+from dolbyio_rest_apis.streaming.models.publish_token import CreatePublishToken, CreateUpdatePublishTokenStream
+
+api_secret = "" # Retrieve your API Secret from the dashboard
+
+create_token = CreatePublishToken('my_token')
+create_token.streams.append(CreateUpdatePublishTokenStream('feed1', False))
+
+loop = asyncio.get_event_loop()
+task = publish_token.create(api_secret, create_token)
+token = loop.run_until_complete(task)
+
+print(token)
+```
+
+### Create a subscribe token
+
+```python
+const dolbyio = require('@dolbyio/dolbyio-rest-apis-client');
+
+const subscribeToken = await dolbyio.streaming.subscribeToken.create('api_secret', {
+    label: 'My token',
+    streams: [
+        {
+            streamName: 'feedA',
+        },
+    ],
+});
+console.log(subscribeToken);
+```
+
 ## Media Examples
 
 ### Media Input and Output

client/src/dolbyio_rest_apis/streaming/cluster.py

@@ -0,0 +1,38 @@
+"""
+dolbyio_rest_apis.streaming.cluster
+~~~~~~~~~~~~~~~
+
+This module contains the functions to work with the Cluster APIs.
+"""
+
+from dolbyio_rest_apis.streaming.internal.http_context import StreamingHttpContext
+from dolbyio_rest_apis.streaming.internal.urls import SAPI_URL
+from dolbyio_rest_apis.streaming.models.cluster import ClusterResponse
+
+async def read(
+        api_secret: str,
+    ) -> ClusterResponse:
+    async with StreamingHttpContext() as http_context:
+        json_response = await http_context.requests_get(
+            api_secret=api_secret,
+            url=f'{SAPI_URL}/api/cluster',
+        )
+
+    return ClusterResponse(json_response)
+
+async def update(
+        api_secret: str,
+        default_cluster: str,
+    ) -> ClusterResponse:
+    payload = {
+        'defaultCluster': default_cluster,
+    }
+
+    async with StreamingHttpContext() as http_context:
+        json_response = await http_context.requests_put(
+            api_secret=api_secret,
+            url=f'{SAPI_URL}/api/cluster',
+            payload=payload,
+        )
+
+    return ClusterResponse(json_response)