diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..bd20811 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,52 @@ +name: Publish Python Package + +on: + release: + types: [created] + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + cache: pip + cache-dependency-path: pyproject.toml + - name: Install dependencies + run: | + pip install '.[test]' + - name: Run tests + run: | + pytest + deploy: + runs-on: ubuntu-latest + needs: [test] + environment: release + permissions: + id-token: write + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.12" + cache: pip + cache-dependency-path: pyproject.toml + - name: Install dependencies + run: | + pip install setuptools wheel build + - name: Build + run: | + python -m build + - name: Publish + uses: pypa/gh-action-pypi-publish@release/v1 + diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..ecb14b2 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,28 @@ +name: Test + +on: [push, pull_request] + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + cache: pip + cache-dependency-path: pyproject.toml + - name: Install dependencies + run: | + pip install '.[test]' + - name: Run tests + run: | + pytest + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0cbfbfa --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +.venv +__pycache__/ +*.py[cod] +*$py.class +venv +.eggs +.pytest_cache +*.egg-info +.DS_Store +dist +build diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cbce8d2 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# streampot + +[![PyPI](https://img.shields.io/pypi/v/streampot.svg)](https://pypi.org/project/streampot/) +[![Tests](https://github.com/streampot/streampot/actions/workflows/test.yml/badge.svg)](https://github.com/streampot/streampot/actions/workflows/test.yml) +[![Changelog](https://img.shields.io/github/v/release/streampot/streampot?include_prereleases&label=changelog)](https://github.com/streampot/streampot/releases) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/streampot/streampot/blob/main/LICENSE) + +API client for StreamPot + +## Installation + +Install this library using `pip`: +```bash +pip install streampot +``` +## Usage + +Usage instructions go here. + +## Development + +To contribute to this library, first checkout the code. Then create a new virtual environment: +```bash +cd streampot +python -m venv venv +source venv/bin/activate +``` +Now install the dependencies and test dependencies: +```bash +pip install -e '.[test]' +``` +To run the tests: +```bash +pytest +``` diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..8835dc8 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,34 @@ +[project] +name = "streampot" +version = "0.1" +description = "API client for StreamPot.io" +readme = "README.md" +requires-python = ">=3.8" +authors = [ + {name = "Jack Bridger"}, + {name = "Ostap Brehin"} +] +license = {text = "Apache-2.0"} +classifiers = [ + "License :: OSI Approved :: Apache Software License" +] +dependencies = [ + "requests >= 2.25" +] + +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[project.urls] +Homepage = "https://github.com/StreamPot/python-sdk" +Changelog = "https://github.com/StreamPot/python-sdk/releases" +Issues = "https://github.com/StreamPot/python-sdk/issues" +CI = "https://github.com/StreamPot/python-sdk/actions" + + +[project.optional-dependencies] +test = [ + "pytest", + "requests-mock" +] diff --git a/streampot/__init__.py b/streampot/__init__.py new file mode 100644 index 0000000..5e51dba --- /dev/null +++ b/streampot/__init__.py @@ -0,0 +1,2 @@ +from . _client import StreamPotClient as StreamPot +from . _client import JobEntity, JobStatus diff --git a/streampot/_client.py b/streampot/_client.py new file mode 100644 index 0000000..c75ef9f --- /dev/null +++ b/streampot/_client.py @@ -0,0 +1,60 @@ +import requests +from dataclasses import dataclass +from typing import List, Optional +from enum import Enum, auto + +@dataclass +class Asset: + name: str + url: str + +class JobStatus(Enum): + PENDING = auto() + COMPLETED = auto() + FAILED = auto() + UPLOADING = auto() + +@dataclass +class JobEntity: + id: int + status: JobStatus + created_at: str + assets: Optional[List[Asset]] = None + +class StreamPotClient: + def __init__(self, secret: str, base_url: str = 'https://api.streampot.io/v1'): + self.secret = secret + self.base_url = base_url + self.actions = [] + + def check_status(self, job_id: str) -> dict: + response = requests.get(f"{self.base_url}/jobs/{job_id}", headers=self._auth_header()) + response.raise_for_status() + return response.json() + + def run(self) -> JobEntity: + response = requests.post(f"{self.base_url}/", headers=self._auth_header(json=True), json=self.actions) + response.raise_for_status() + + job_data = response.json() + job_data['status'] = JobStatus[job_data['status'].upper()] + + return JobEntity(**job_data) + + def _auth_header(self, json: bool = False) -> dict: + headers = {"Authorization": f"Bearer {self.secret}"} + if json: + headers['Accept'] = 'application/json' + headers['Content-Type'] = 'application/json' + return headers + + def add_action(self, name: str, *values): + self.actions.append({"name": name, "value": values}) + + # All the actions methods + + def merge_add(self, source: str): + self.add_action('mergeAdd', source) + return self + + \ No newline at end of file diff --git a/tests/test_streampot.py b/tests/test_streampot.py new file mode 100644 index 0000000..d4c750a --- /dev/null +++ b/tests/test_streampot.py @@ -0,0 +1,53 @@ +import pytest +import requests_mock +from streampot import StreamPot, JobEntity, JobStatus + +@pytest.fixture +def stream_pot(): + return StreamPot(secret='test_secret') + +def test_initialization(stream_pot): + assert stream_pot.secret == 'test_secret' + assert stream_pot.base_url == 'https://api.streampot.io/v1' + assert isinstance(stream_pot.actions, list) + assert len(stream_pot.actions) == 0 + +def test_check_status(stream_pot): + with requests_mock.Mocker() as m: + job_id = '123' + mock_url = f"{stream_pot.base_url}/jobs/{job_id}" + mock_response = {'id': 123, 'status': 'completed', 'created_at': '2020-01-01'} + m.get(mock_url, json=mock_response) + + response = stream_pot.check_status(job_id) + assert response == mock_response + +def test_run(stream_pot): + with requests_mock.Mocker() as m: + mock_url = f"{stream_pot.base_url}/" + mock_response = {'id': 124, 'status': 'pending', 'created_at': '2020-01-02'} + m.post(mock_url, json=mock_response) + + response = stream_pot.run() + assert isinstance(response, JobEntity) + assert response.id == 124 + assert response.status == JobStatus.PENDING + assert response.created_at == '2020-01-02' + +def test_add_action(stream_pot): + stream_pot.merge_add('source_video.mp4') + assert len(stream_pot.actions) == 1 + assert stream_pot.actions[0]['name'] == 'mergeAdd' + assert stream_pot.actions[0]['value'] == ('source_video.mp4',) + +@pytest.mark.parametrize("method, expected_action", [ + ("merge_add", 'mergeAdd'), + # ("add_input", 'addInput'), + # add more methods and expected actions as necessary +]) +def test_actions(stream_pot, method, expected_action): + action_method = getattr(stream_pot, method) + action_method('example_source') + assert len(stream_pot.actions) == 1 + assert stream_pot.actions[0]['name'] == expected_action + assert stream_pot.actions[0]['value'] == ('example_source',)