typecast-python 0.3.11__py3-none-any.whl → 0.3.13__py3-none-any.whl

typecast/_user_agent.py

@@ -1,10 +1,35 @@
 import platform
+import re
 import sys
 from importlib import metadata
+from typing import Optional
 
 from . import conf
 
 
+_GENERATED_BY_PATTERN = re.compile(r"[a-z0-9][a-z0-9._-]{0,31}\Z")
+
+
+def attribution_suffix(
+    source: Optional[str] = None,
+    generated_by: Optional[str] = None,
+) -> str:
+    if source is None and generated_by is None:
+        return ""
+    if (
+        not isinstance(source, str)
+        or not isinstance(generated_by, str)
+        or source not in {"llms", "skill", "api-page", "api-docs"}
+        or not generated_by
+    ):
+        raise ValueError(
+            "source (llms, skill, api-page, or api-docs) and generated_by must be provided together"
+        )
+    if not _GENERATED_BY_PATTERN.fullmatch(generated_by):
+        raise ValueError("generated_by must be a lowercase token of at most 32 characters")
+    return f" typecast-integration/1 (source={source}; generated_by={generated_by})"
+
+
 def _package_version(package_name: str) -> str:
     try:
         return metadata.version(package_name)
@@ -36,6 +61,8 @@ def build_user_agent(
     http_library: str,
     host: str,
     transport: str = "rest",
+    source: Optional[str] = None,
+    generated_by: Optional[str] = None,
 ) -> str:
     sdk_version = _package_version("typecast-python")
     base = "default" if conf.is_default_host(host) else "custom"
@@ -46,31 +73,54 @@ def build_user_agent(
         f"{http_library} "
         f"(mode={mode}; base={base}; transport={transport}; "
         f"os={_os_name()}; arch={_arch_name()}; sdk_env=python; platform=server)"
+        f"{attribution_suffix(source, generated_by)}"
     )
 
 
-def requests_user_agent(host: str, transport: str = "rest") -> str:
+def requests_user_agent(
+    host: str,
+    transport: str = "rest",
+    source: Optional[str] = None,
+    generated_by: Optional[str] = None,
+) -> str:
     return build_user_agent(
         mode="sync",
         http_library=f"requests/{_package_version('requests')}",
         host=host,
         transport=transport,
+        source=source,
+        generated_by=generated_by,
     )
 
 
-def aiohttp_user_agent(host: str, transport: str = "rest") -> str:
+def aiohttp_user_agent(
+    host: str,
+    transport: str = "rest",
+    source: Optional[str] = None,
+    generated_by: Optional[str] = None,
+) -> str:
     return build_user_agent(
         mode="async",
         http_library=f"aiohttp/{_package_version('aiohttp')}",
         host=host,
         transport=transport,
+        source=source,
+        generated_by=generated_by,
     )
 
 
-def httpx_user_agent(host: str, mode: str, transport: str = "rest") -> str:
+def httpx_user_agent(
+    host: str,
+    mode: str,
+    transport: str = "rest",
+    source: Optional[str] = None,
+    generated_by: Optional[str] = None,
+) -> str:
     return build_user_agent(
         mode=mode,
         http_library=f"httpx/{_package_version('httpx')}",
         host=host,
         transport=transport,
+        source=source,
+        generated_by=generated_by,
     )

typecast/async_client.py

@@ -17,7 +17,7 @@ from ._voice_clone import (
     validate_clone_inputs,
     validate_custom_voice_id,
 )
-from ._user_agent import aiohttp_user_agent, httpx_user_agent
+from ._user_agent import aiohttp_user_agent, attribution_suffix, httpx_user_agent
 
 if TYPE_CHECKING or sys.version_info < (3, 10):  # pragma: no cover
     from ._httpx_compat import AiohttpCompatSession, ClientTimeout, FormData
@@ -77,6 +77,8 @@ class AsyncTypecast:
         host: Optional[str] = None,
         api_key: Optional[str] = None,
         session: Optional[Any] = None,
+        source: Optional[str] = None,
+        generated_by: Optional[str] = None,
     ):
         """Initialize the async Typecast client.
 
@@ -88,6 +90,8 @@ class AsyncTypecast:
                 __aenter__ will not create a new session and __aexit__ will not close it
                 (the caller owns its lifecycle). Auth headers (`X-API-KEY`, `User-Agent`)
                 are attached per-request via `_request_headers()`.
+            source: Integration source: 'llms', 'skill', 'api-page', or 'api-docs'.
+            generated_by: Lowercase token identifying the coding agent.
 
         Raises:
             ValueError: If no API key is provided and TYPECAST_API_KEY is not set
@@ -95,6 +99,9 @@ class AsyncTypecast:
         """
         self.host = conf.get_host(host)
         self.api_key = conf.get_api_key(api_key)
+        attribution_suffix(source, generated_by)
+        self.source = source
+        self.generated_by = generated_by
         if not self.api_key and conf.is_default_host(self.host):
             raise ValueError("API key is required for the default Typecast API host")
         self._owns_session = session is None
@@ -106,9 +113,16 @@ class AsyncTypecast:
         if self.session is None:
             headers = {
                 "User-Agent": (
-                    aiohttp_user_agent(self.host)
+                    aiohttp_user_agent(
+                        self.host, source=self.source, generated_by=self.generated_by
+                    )
                     if aiohttp
-                    else httpx_user_agent(self.host, "async")
+                    else httpx_user_agent(
+                        self.host,
+                        "async",
+                        source=self.source,
+                        generated_by=self.generated_by,
+                    )
                 )
             }
             if self.api_key:
@@ -157,7 +171,11 @@ class AsyncTypecast:
         """
         if self._owns_session:
             return None
-        headers = {"User-Agent": aiohttp_user_agent(self.host)}
+        headers = {
+            "User-Agent": aiohttp_user_agent(
+                self.host, source=self.source, generated_by=self.generated_by
+            )
+        }
         if self.api_key:
             headers["X-API-KEY"] = self.api_key
         return headers

typecast/client.py

@@ -16,7 +16,7 @@ from ._voice_clone import (
     validate_clone_inputs,
     validate_custom_voice_id,
 )
-from ._user_agent import httpx_user_agent, requests_user_agent
+from ._user_agent import attribution_suffix, httpx_user_agent, requests_user_agent
 
 if TYPE_CHECKING or sys.version_info < (3, 10):  # pragma: no cover
     from ._httpx_compat import RequestsCompatSession
@@ -111,6 +111,8 @@ class Typecast:
         host: Optional[str] = None,
         api_key: Optional[str] = None,
         session: Optional[Any] = None,
+        source: Optional[str] = None,
+        generated_by: Optional[str] = None,
     ):
         """Initialize the Typecast client.
 
@@ -122,12 +124,17 @@ class Typecast:
                 the client will not create a new session nor close it; auth headers
                 (`X-API-KEY`, `User-Agent`) are attached per-request via
                 `_request_headers()`.
+            source: Integration source: 'llms', 'skill', 'api-page', or 'api-docs'.
+            generated_by: Lowercase token identifying the coding agent.
 
         Raises:
             ValueError: If no API key is provided and TYPECAST_API_KEY is not set.
         """
         self.host = conf.get_host(host)
         self.api_key = conf.get_api_key(api_key)
+        attribution_suffix(source, generated_by)
+        self.source = source
+        self.generated_by = generated_by
         if not self.api_key and conf.is_default_host(self.host):
             raise ValueError("API key is required for the default Typecast API host")
         self._owns_session = session is None
@@ -139,9 +146,9 @@ class Typecast:
             headers = {
                 "Content-Type": "application/json",
                 "User-Agent": (
-                    requests_user_agent(self.host)
+                    requests_user_agent(self.host, source=source, generated_by=generated_by)
                     if requests
-                    else httpx_user_agent(self.host, "sync")
+                    else httpx_user_agent(self.host, "sync", source=source, generated_by=generated_by)
                 ),
             }
             if self.api_key:
@@ -179,7 +186,11 @@ class Typecast:
         """
         if self._owns_session:
             return None
-        headers = {"User-Agent": requests_user_agent(self.host)}
+        headers = {
+            "User-Agent": requests_user_agent(
+                self.host, source=self.source, generated_by=self.generated_by
+            )
+        }
         if self.api_key:
             headers["X-API-KEY"] = self.api_key
         return headers

{typecast_python-0.3.11.dist-info → typecast_python-0.3.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: typecast-python
-Version: 0.3.11
+Version: 0.3.13
 Summary: Official Typecast Python SDK - Convert text to lifelike speech using AI-powered voices
 Project-URL: Homepage, https://typecast.ai
 Project-URL: Documentation, https://typecast.ai/docs/overview
@@ -235,12 +235,12 @@ Requires-Dist: typing-extensions>=4.0.0
 Provides-Extra: dev
 Requires-Dist: aioresponses>=0.7.6; extra == 'dev'
 Requires-Dist: black<27.0.0,>=26.3.1; extra == 'dev'
-Requires-Dist: flake8<6.0.0,>=5.0.0; extra == 'dev'
+Requires-Dist: flake8<8.0.0,>=5.0.0; extra == 'dev'
 Requires-Dist: httpx<1.0.0,>=0.28.1; extra == 'dev'
 Requires-Dist: isort>=5.0.0; extra == 'dev'
-Requires-Dist: mypy<1.11.0,>=1.0.0; extra == 'dev'
+Requires-Dist: mypy<2.4.0,>=1.0.0; extra == 'dev'
 Requires-Dist: pytest-asyncio<2.0.0,>=1.4.0; extra == 'dev'
-Requires-Dist: pytest-cov<6.0.0,>=5.0.0; extra == 'dev'
+Requires-Dist: pytest-cov<8.0.0,>=5.0.0; extra == 'dev'
 Requires-Dist: pytest-mock>=3.14.0; extra == 'dev'
 Requires-Dist: pytest<10.0.0,>=9.0.3; extra == 'dev'
 Description-Content-Type: text/markdown

{typecast_python-0.3.11.dist-info → typecast_python-0.3.13.dist-info}/RECORD

@@ -1,9 +1,9 @@
 typecast/__init__.py,sha256=L6m0Z1jn1UgGjPp9AFiTwhHk9DVV_B4WrLfQDEfbcZI,1093
 typecast/_httpx_compat.py,sha256=Xw4AvybiiXyaA2WATBUYHwST8clE8R7R0flLMpdvBC4,6170
-typecast/_user_agent.py,sha256=emfsf4-W8csOh34WdqTYW_aijAuP5GyN-hc75VKkPnc,2009
+typecast/_user_agent.py,sha256=dCiHkvCuTQOz5qYxk4vmxEzL7qZUo9ceKmjXsQUM5wI,3417
 typecast/_voice_clone.py,sha256=TN2tbB3b5lC5uFCBnbERhz37bNJlbv6VZ-vj70EfTs4,3464
-typecast/async_client.py,sha256=9Zi7G4EB_j8YPsJDF1huZ7_4r_8GcGWrc683iA-EAG0,22668
-typecast/client.py,sha256=3URvoIplmEouYHZKpQryXyELAsjPNeCPXEYNvQBFTd0,22209
+typecast/async_client.py,sha256=igeZye1Npjf1bFeiTuKMFEN2BxgWmR8DLToP7m3gNxw,23418
+typecast/client.py,sha256=08YEMhSbTqcVlW54ZC6fyJiGxR3CnODrMT4eaFsqjaw,22774
 typecast/composer.py,sha256=pkRSVIv99uuAwPyOXw7KSW7NAkqvAUK4hCS5pmBb7bA,7313
 typecast/conf.py,sha256=yfOHYZDvIshWWMriN5wE0GFPR8AX3zv4Rg2655OvA9Q,724
 typecast/exceptions.py,sha256=Y0ZzYebe8zOSOSAHbXfKR0G_RJgdmZXxi15Z7ZxPLIk,1568
@@ -13,7 +13,7 @@ typecast/models/error.py,sha256=XomIjx7jvlCjItqzJuCAT4mXC9jwTjxR8lLDUk6P8KA,152
 typecast/models/subscription.py,sha256=EIaAAo3cCRw8LYT_O6D9AVwxqIHrWCijzl4UTx7FZB8,894
 typecast/models/tts.py,sha256=xiO1e936vFr7vZqUErTEhexydoaMem6BcY_x1A1zFow,16495
 typecast/models/voices.py,sha256=3UeBLwAlaNbQQUrt7FO18zqczLoP7jmi2x68yaUtllU,2687
-typecast_python-0.3.11.dist-info/METADATA,sha256=qT8wDrSV7smUnouc935T7r1QpC-nyX678XVotcrcNYY,25948
-typecast_python-0.3.11.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
-typecast_python-0.3.11.dist-info/licenses/LICENSE,sha256=HvtJ-S89uUkuYmt-OvVk4MRxmzwtbn84__qJtSrGU2Q,11348
-typecast_python-0.3.11.dist-info/RECORD,,
+typecast_python-0.3.13.dist-info/METADATA,sha256=LmoUpiY-EyHT3sHfSK2bt2qFPlL-IBq_JL_wtbHM8-Y,25947
+typecast_python-0.3.13.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+typecast_python-0.3.13.dist-info/licenses/LICENSE,sha256=HvtJ-S89uUkuYmt-OvVk4MRxmzwtbn84__qJtSrGU2Q,11348
+typecast_python-0.3.13.dist-info/RECORD,,

{typecast_python-0.3.11.dist-info → typecast_python-0.3.13.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.31.0
+Generator: hatchling 1.32.0
 Root-Is-Purelib: true
 Tag: py3-none-any