tvpulse 0.1.0__tar.gz

tvpulse-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 SDio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tvpulse-0.1.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: tvpulse
+Version: 0.1.0
+Summary: Official TVPulse SDK for Python
+Home-page: https://github.com/sdio/tvpulse-python-sdk
+Author: SDIO
+Author-email: SDIO <dev@sdio.io>
+Project-URL: Homepage, https://github.com/sdio/tvpulse-python-sdk
+Project-URL: Bug Tracker, https://github.com/sdio/tvpulse-python-sdk/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+
+# TVPulse Python SDK
+
+The official Python SDK for the TVPulse API.
+
+## Installation
+
+```bash
+pip install tvpulse
+```
+
+## Usage
+
+First, you need to initialize the `Client` with your API key. You can get your API key from the TVPulse UI.
+
+```python
+import os
+from tvpulse import Client, TVPulseError
+
+# Initialize the SDK
+# It's recommended to store your API key in an environment variable.
+api_key = os.environ.get("TVPULSE_API_KEY")
+if not api_key:
+  raise ValueError("TVPULSE_API_KEY environment variable not set.")
+
+client = Client(api_key=api_key)
+```
+
+### Get Data
+
+You can use the `get_data` method to retrieve data from the API. This method takes the following arguments:
+
+- `searchTypes`: A list of search types to use. Currently, only one search type is supported at a time. Valid search types are `"asr"` and `"ocr"`.
+- `keyword`: The keyword to search for.
+- `streams`: A list of streams to search.
+- `start_date`: The start date of the search in `YYYY-MM-DD HH:MM:SS` format.
+- `end_date`: The end date of the search in `YYYY-MM-DD HH:MM:SS` format.
+- `frequency`: The frequency of the search. Valid values are `"hour"` and `"day"`.
+- `score_threshold`: The score threshold for the search. This should be a float between 0 and 1.
+
+Here's an example of how to use the `get_data` method:
+
+```python
+try:
+  data = client.get_data(
+      searchTypes=["asr"],
+      keyword="コーヒー",
+      streams=["CX", "EX", "NTV", "TBS", "TX"],
+      start_date="2025-01-01 00:00:00",
+      end_date="2025-01-02 23:59:59",
+      frequency="hour",
+      score_threshold=0.95
+  )
+  print(data)
+except TVPulseError as e:
+  print(f"An error occurred: {e}")
+```
+
+### Error Handling
+
+The SDK raises custom exceptions for different types of errors. You can catch these exceptions to handle errors gracefully.
+
+- `TVPulseError`: The base class for all SDK errors.
+- `AuthenticationError`: Raised when there is an authentication error (e.g., an invalid API key).
+- `InvalidRequestError`: Raised when the request is invalid (e.g., a missing or invalid parameter).

tvpulse-0.1.0/README.md

@@ -0,0 +1,64 @@
+# TVPulse Python SDK
+
+The official Python SDK for the TVPulse API.
+
+## Installation
+
+```bash
+pip install tvpulse
+```
+
+## Usage
+
+First, you need to initialize the `Client` with your API key. You can get your API key from the TVPulse UI.
+
+```python
+import os
+from tvpulse import Client, TVPulseError
+
+# Initialize the SDK
+# It's recommended to store your API key in an environment variable.
+api_key = os.environ.get("TVPULSE_API_KEY")
+if not api_key:
+  raise ValueError("TVPULSE_API_KEY environment variable not set.")
+
+client = Client(api_key=api_key)
+```
+
+### Get Data
+
+You can use the `get_data` method to retrieve data from the API. This method takes the following arguments:
+
+- `searchTypes`: A list of search types to use. Currently, only one search type is supported at a time. Valid search types are `"asr"` and `"ocr"`.
+- `keyword`: The keyword to search for.
+- `streams`: A list of streams to search.
+- `start_date`: The start date of the search in `YYYY-MM-DD HH:MM:SS` format.
+- `end_date`: The end date of the search in `YYYY-MM-DD HH:MM:SS` format.
+- `frequency`: The frequency of the search. Valid values are `"hour"` and `"day"`.
+- `score_threshold`: The score threshold for the search. This should be a float between 0 and 1.
+
+Here's an example of how to use the `get_data` method:
+
+```python
+try:
+  data = client.get_data(
+      searchTypes=["asr"],
+      keyword="コーヒー",
+      streams=["CX", "EX", "NTV", "TBS", "TX"],
+      start_date="2025-01-01 00:00:00",
+      end_date="2025-01-02 23:59:59",
+      frequency="hour",
+      score_threshold=0.95
+  )
+  print(data)
+except TVPulseError as e:
+  print(f"An error occurred: {e}")
+```
+
+### Error Handling
+
+The SDK raises custom exceptions for different types of errors. You can catch these exceptions to handle errors gracefully.
+
+- `TVPulseError`: The base class for all SDK errors.
+- `AuthenticationError`: Raised when there is an authentication error (e.g., an invalid API key).
+- `InvalidRequestError`: Raised when the request is invalid (e.g., a missing or invalid parameter).

tvpulse-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tvpulse"
+version = "0.1.0"
+authors = [
+  { name="SDIO", email="dev@sdio.io" },
+]
+description = "Official TVPulse SDK for Python"
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/sdio/tvpulse-python-sdk"
+"Bug Tracker" = "https://github.com/sdio/tvpulse-python-sdk/issues"

tvpulse-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tvpulse-0.1.0/setup.py

@@ -0,0 +1,22 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='tvpulse',
+    version='0.1.0',
+    packages=find_packages(),
+    install_requires=[
+        'requests',
+        'pydantic',
+    ],
+    author='SDIO',
+    author_email='dev@sdio.io',
+    description='Official TVPulse SDK for Python',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    url='https://github.com/sdio/tvpulse-python-sdk',
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+)

tvpulse-0.1.0/tests/test_client.py

@@ -0,0 +1,59 @@
+import unittest
+from unittest.mock import MagicMock, patch
+from tvpulse.client import Client
+from tvpulse.exceptions import InvalidRequestError
+
+
+class TestClient(unittest.TestCase):
+
+  def setUp(self):
+    self.api_key = "test_api_key"
+    self.client = Client(api_key=self.api_key)
+    self.test_params = {
+        "keyword": "test",
+        "streams": ["TBS"],
+        "start_date": "2025-01-01 00:00:00",
+        "end_date": "2025-01-01 06:00:00",
+        "frequency": "hour",
+        "score_threshold": 0.95
+    }
+
+  @patch('tvpulse.api.API.search_voice')
+  def test_get_data_asr(self, mock_search_voice):
+    mock_search_voice.return_value = {"data": [], "next_page_token": None}
+    response = self.client.get_data(searchTypes=["asr"], **self.test_params)
+    self.assertIsNotNone(response)
+    mock_search_voice.assert_called_once_with(**self.test_params)
+
+  @patch('tvpulse.api.API.search_text')
+  def test_get_data_ocr(self, mock_search_text):
+    mock_search_text.return_value = {"data": [], "next_page_token": None}
+    response = self.client.get_data(searchTypes=["ocr"], **self.test_params)
+    self.assertIsNotNone(response)
+    mock_search_text.assert_called_once_with(**self.test_params)
+
+  def test_get_data_no_search_types(self):
+    with self.assertRaises(TypeError):
+      self.client.get_data(**self.test_params)
+
+  def test_get_data_empty_search_types(self):
+    with self.assertRaises(InvalidRequestError):
+      self.client.get_data(searchTypes=[], **self.test_params)
+
+  def test_get_data_multiple_search_types(self):
+    with self.assertRaises(InvalidRequestError):
+      self.client.get_data(searchTypes=["asr", "ocr"], **self.test_params)
+
+  def test_get_data_invalid_search_type(self):
+    with self.assertRaises(InvalidRequestError):
+      self.client.get_data(searchTypes=["invalid"], **self.test_params)
+
+  def test_get_data_invalid_stream(self):
+    with self.assertRaises(InvalidRequestError):
+      params = self.test_params.copy()
+      params["streams"] = ["invalid"]
+      self.client.get_data(searchTypes=["asr"], **params)
+
+
+if __name__ == '__main__':
+  unittest.main()

tvpulse-0.1.0/tvpulse/__init__.py

@@ -0,0 +1,5 @@
+from .client import Client
+from .__version__ import __version__
+from .exceptions import TVPulseError, AuthenticationError, InvalidRequestError
+
+__all__ = ["Client", "__version__", "TVPulseError", "AuthenticationError", "InvalidRequestError"]

tvpulse-0.1.0/tvpulse/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

tvpulse-0.1.0/tvpulse/api.py

@@ -0,0 +1,69 @@
+import requests
+
+
+class API:
+  """
+  A wrapper for the TVPulse API.
+  """
+  BASE_URL = "https://gateway.dev.sdio.co.jp/v1/api"
+
+  def __init__(self, api_key: str):
+    """
+    Initializes the API client with the given API key.
+
+    Args:
+      api_key: The API key to use for authentication.
+    """
+    self.api_key = api_key
+    self.headers = {"X-API-KEY": self.api_key}
+
+  def _request(self, method: str, endpoint: str, **kwargs):
+    """
+    Makes a request to the API.
+
+    Args:
+      method: The HTTP method to use (e.g., "GET", "POST").
+      endpoint: The API endpoint to call.
+      **kwargs: Additional keyword arguments to pass to the request.
+
+    Returns:
+      The JSON response from the API.
+    """
+    url = f"{self.BASE_URL}/{endpoint}"
+    response = requests.request(method, url, headers=self.headers, **kwargs)
+    print(f"Request URL: {response.url}"
+          )  # Debugging line to print the request URL
+    print(f"Response Status Code: {response.status_code}")  # Debugging line to
+    if response.status_code == 403:
+      from .exceptions import AuthenticationError
+      raise AuthenticationError("Invalid API key or insufficient permissions.")
+    response.raise_for_status()
+    return response.json()
+
+  def search_text(self, keyword: str, streams: list, start_date: str, end_date: str, frequency: str, score_threshold: float):
+    """
+    Performs a text search.
+    """
+    payload = {
+        "keyword": keyword,
+        "streams": streams,
+        "start_date": start_date,
+        "end_date": end_date,
+        "frequency": frequency,
+        "score_threshold": score_threshold,
+    }
+    return self._request("POST", "text/search", json=payload)
+
+  def search_voice(self, keyword: str, streams: list, start_date: str, end_date: str, frequency: str, score_threshold: float):
+    """
+    Performs a voice search.
+    """
+    payload = {
+        "keyword": keyword,
+        "streams": streams,
+        "start_date": start_date,
+        "end_date": end_date,
+        "frequency": frequency,
+        "score_threshold": score_threshold,
+    }
+    return self._request("POST", "voice/search", json=payload)

tvpulse-0.1.0/tvpulse/client.py

@@ -0,0 +1,81 @@
+from .api import API
+from .exceptions import InvalidRequestError
+from .models import APIResponse
+
+
+class Client:
+  """
+  The main client for interacting with the TVPulse API.
+  """
+
+  def __init__(self, api_key: str):
+    """
+    Initializes the client with the given API key.
+
+    Args:
+      api_key: The API key to use for authentication.
+    """
+    self.api = API(api_key)
+
+  def get_data(self, searchTypes: list, keyword: str, streams: list,
+               start_date: str, end_date: str, frequency: str,
+               score_threshold: float):
+    """
+    Gets data from the TVPulse API.
+
+    Args:
+      searchTypes: A list of search types to use.
+      keyword: The keyword to search for.
+      streams: A list of streams to search.
+      start_date: The start date of the search.
+      end_date: The end date of the search.
+      frequency: The frequency of the search.
+      score_threshold: The score threshold for the search.
+
+    Returns:
+      The JSON response from the API.
+    """
+    search_types = searchTypes
+    if not isinstance(search_types, list):
+      raise InvalidRequestError("searchTypes must be a list.")
+
+    if not search_types:
+      raise InvalidRequestError("searchTypes cannot be empty.")
+
+    if not isinstance(streams, list):
+      raise InvalidRequestError("streams must be a list.")
+
+    if not streams:
+      raise InvalidRequestError("streams cannot be empty.")
+
+    supported_streams = ["cx", "ex", "mx", "nhk", "ntv", "tbs", "tx"]
+    for stream in streams:
+      if stream.lower() not in supported_streams:
+        raise InvalidRequestError(
+            f"Invalid stream: {stream}. Supported streams are: {supported_streams}"
+        )
+
+    if len(search_types) > 1:
+      # For now, we only support one search type at a time.
+      # This can be extended to support multiple search types in the future.
+      raise InvalidRequestError("Only one search type is supported at a time.")
+
+    search_type = search_types[0]
+    if search_type == "asr":
+      response = self.api.search_voice(keyword=keyword,
+                                       streams=streams,
+                                       start_date=start_date,
+                                       end_date=end_date,
+                                       frequency=frequency,
+                                       score_threshold=score_threshold)
+    elif search_type == "ocr":
+      response = self.api.search_text(keyword=keyword,
+                                      streams=streams,
+                                      start_date=start_date,
+                                      end_date=end_date,
+                                      frequency=frequency,
+                                      score_threshold=score_threshold)
+    else:
+      raise InvalidRequestError(f"Invalid search type: {search_type}")
+
+    return APIResponse(**response)

tvpulse-0.1.0/tvpulse/exceptions.py

@@ -0,0 +1,19 @@
+class TVPulseError(Exception):
+  """
+  Base class for all TVPulse SDK errors.
+  """
+  pass
+
+
+class AuthenticationError(TVPulseError):
+  """
+  Raised when there is an authentication error.
+  """
+  pass
+
+
+class InvalidRequestError(TVPulseError):
+  """
+  Raised when the request is invalid.
+  """
+  pass

tvpulse-0.1.0/tvpulse/models.py

@@ -0,0 +1,20 @@
+from typing import List, Optional
+from pydantic import BaseModel
+
+
+class DataPoint(BaseModel):
+  """
+  Represents a single data point in the API response.
+  """
+  stream: str
+  date_time: str
+  count: int
+  source: Optional[str] = None
+
+
+class APIResponse(BaseModel):
+  """
+  Represents the overall API response.
+  """
+  data: List[DataPoint]
+  next_page_token: Optional[str] = None

tvpulse-0.1.0/tvpulse.egg-info/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: tvpulse
+Version: 0.1.0
+Summary: Official TVPulse SDK for Python
+Home-page: https://github.com/sdio/tvpulse-python-sdk
+Author: SDIO
+Author-email: SDIO <dev@sdio.io>
+Project-URL: Homepage, https://github.com/sdio/tvpulse-python-sdk
+Project-URL: Bug Tracker, https://github.com/sdio/tvpulse-python-sdk/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+
+# TVPulse Python SDK
+
+The official Python SDK for the TVPulse API.
+
+## Installation
+
+```bash
+pip install tvpulse
+```
+
+## Usage
+
+First, you need to initialize the `Client` with your API key. You can get your API key from the TVPulse UI.
+
+```python
+import os
+from tvpulse import Client, TVPulseError
+
+# Initialize the SDK
+# It's recommended to store your API key in an environment variable.
+api_key = os.environ.get("TVPULSE_API_KEY")
+if not api_key:
+  raise ValueError("TVPULSE_API_KEY environment variable not set.")
+
+client = Client(api_key=api_key)
+```
+
+### Get Data
+
+You can use the `get_data` method to retrieve data from the API. This method takes the following arguments:
+
+- `searchTypes`: A list of search types to use. Currently, only one search type is supported at a time. Valid search types are `"asr"` and `"ocr"`.
+- `keyword`: The keyword to search for.
+- `streams`: A list of streams to search.
+- `start_date`: The start date of the search in `YYYY-MM-DD HH:MM:SS` format.
+- `end_date`: The end date of the search in `YYYY-MM-DD HH:MM:SS` format.
+- `frequency`: The frequency of the search. Valid values are `"hour"` and `"day"`.
+- `score_threshold`: The score threshold for the search. This should be a float between 0 and 1.
+
+Here's an example of how to use the `get_data` method:
+
+```python
+try:
+  data = client.get_data(
+      searchTypes=["asr"],
+      keyword="コーヒー",
+      streams=["CX", "EX", "NTV", "TBS", "TX"],
+      start_date="2025-01-01 00:00:00",
+      end_date="2025-01-02 23:59:59",
+      frequency="hour",
+      score_threshold=0.95
+  )
+  print(data)
+except TVPulseError as e:
+  print(f"An error occurred: {e}")
+```
+
+### Error Handling
+
+The SDK raises custom exceptions for different types of errors. You can catch these exceptions to handle errors gracefully.
+
+- `TVPulseError`: The base class for all SDK errors.
+- `AuthenticationError`: Raised when there is an authentication error (e.g., an invalid API key).
+- `InvalidRequestError`: Raised when the request is invalid (e.g., a missing or invalid parameter).

tvpulse-0.1.0/tvpulse.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+tests/test_client.py
+tvpulse/__init__.py
+tvpulse/__version__.py
+tvpulse/api.py
+tvpulse/client.py
+tvpulse/exceptions.py
+tvpulse/models.py
+tvpulse.egg-info/PKG-INFO
+tvpulse.egg-info/SOURCES.txt
+tvpulse.egg-info/dependency_links.txt
+tvpulse.egg-info/top_level.txt

tvpulse-0.1.0/tvpulse.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tvpulse-0.1.0/tvpulse.egg-info/top_level.txt

@@ -0,0 +1 @@
+tvpulse