feat: rename package to pyannoteai.sdk

Author: hbredin

CHANGELOG.md

@@ -1,5 +1,5 @@
 # CHANGELOG
 
-## Version 0.1.0a0 (2025-03-05)
+## Version 0.1.0a0 (2025-03-14)
 
 - *Hello world!*

README.md

@@ -3,14 +3,14 @@
 </p>
 
 <div align="center">
-    <h1>Official Python pyannoteAI SDK </h1>
+    <h1>Official pyannoteAI Python SDK </h1>
 </div>
 
 
 ## Installation
 
 ```bash
-$ pip install pyannoteAI
+$ pip install pyannoteai.sdk
 ```
 
 Then head over to [`dashboard.pyannote.ai`](https://dashboard.pyannote.ai) and create an API key.
@@ -19,13 +19,15 @@ Then head over to [`dashboard.pyannote.ai`](https://dashboard.pyannote.ai) and c
 
 ```python
 # instantiate client
-from pyannoteai import Client
+from pyannoteai.sdk import Client
 client = Client("your-api-key")
 
 # upload conversation file
 media_url = client.upload('/path/to/conversation.wav')
+
 # submit a diarization job
 job_id = client.diarize(media_url)
+
 # retrieve diarization
 diarization = client.retrieve(job_id)
 # diarization['output']['diarization'] contains diarization output

pyproject.toml

@@ -1,5 +1,5 @@
 [project]
-name = "pyannoteAI"
+name = "pyannoteai-sdk"
 description = "Official pyannoteAI Python SDK"
 readme = "README.md"
 authors = [
@@ -21,3 +21,6 @@ build-backend = "hatchling.build"
 
 [tool.hatch.version]
 source = "vcs"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pyannoteai"]

src/pyannoteai/__init__.py renamed to src/pyannoteai/sdk/__init__.py

@@ -25,14 +25,15 @@
 import io
 import os
 import time
+import warnings
 from pathlib import Path
 from typing import Callable, Optional, Union
 
 import requests
 from requests import Response
 from requests.exceptions import ConnectionError, HTTPError
 
-__version__ = importlib.metadata.version("pyannoteAI")
+__version__ = importlib.metadata.version("pyannoteai-sdk")
 
 
 class PyannoteAIFailedJob(Exception):
@@ -47,7 +48,7 @@ class PyannoteAICanceledJob(Exception):
     pass
 
 
-class UploadingCallbackBytesIO(io.BytesIO):
+class _UploadingCallbackBytesIO(io.BytesIO):
     """BytesIO subclass that calls a callback during the upload process
 
     Parameters
@@ -93,8 +94,9 @@ class Client:
 
     Usage
     -----
+    
     # instantiate client for pyannoteAI web API
-    >>> from pyannoteAI import Client
+    >>> from pyannoteai.sdk import Client
     >>> client = Client(token="{PYANNOTEAI_API_KEY}")
 
     # upload your audio file to the pyannoteAI web API
@@ -204,8 +206,8 @@ def api_key(self, api_key: str) -> None:
         if not api_key:
             raise ValueError(
                 """
-        Failed to authenticate to pyannoteAI web API. Please create an API key on https://dashboard.pyannote.ai/ and
-        provide it either via `PYANNOTEAI_API_TOKEN` environment variable or with `token` parameter."""
+Failed to authenticate to pyannoteAI web API. Please create an API key on https://dashboard.pyannote.ai/ and
+provide it either via `PYANNOTEAI_API_TOKEN` environment variable or with `token` parameter."""
             )
 
         # store the API key and prepare the headers
@@ -285,9 +287,9 @@ def upload(
 
         # for now, only str and Path audio instances are supported
         with open(audio, "rb") as f:
-            # wrap the file object in a UploadingCallbackBytesIO instance
+            # wrap the file object in a _UploadingCallbackBytesIO instance
             # to allow calling the hook during the upload process
-            data = UploadingCallbackBytesIO(callback, total_size, f.read())
+            data = _UploadingCallbackBytesIO(callback, total_size, f.read())
 
         if not (isinstance(media_url, str) and media_url.startswith("media://")):
             raise ValueError(
@@ -312,6 +314,11 @@ def upload(
         # TODO: handle HTTPError returned by the API
         response.raise_for_status()
 
+        warnings.warn("""
+You are using pyannoteAI's temporary storage solution. Your file will be permanently deleted from our servers within 24hs. 
+If you are running in production, we highly recommend to use your own storage to reduce network latency and obtain results faster. 
+Please check our documentation at https://docs.pyannote.ai/ for more information.""")
+
         return media_url
 
     def diarize(
@@ -488,15 +495,16 @@ def retrieve(self, job_id: str, every_seconds: int = 10) -> dict:
             break
 
         if job_status == "failed":
-            error = job.get("output", dict()).get(
-                "error", "Please contact support."
-            )
+            error = job.get("output", dict()).get("error", "Please contact support.")
             raise PyannoteAIFailedJob(error, job_id)
 
         if job_status == "canceled":
-            error = job.get("output", dict()).get(
-                "error", "Please contact support."
-            )
+            error = job.get("output", dict()).get("error", "Please contact support.")
             raise PyannoteAICanceledJob(error, job_id)
 
+        warnings.warn("""
+You are using periodic polling to retrieve results. 
+If you are running in production, we highly recommend to setup a webhook server to obtain results faster, as soon as they are available. 
+Please check our documentation at https://docs.pyannote.ai/ for more information.""")
+
         return job