tinyurl-sdk 0.1.1__py3-none-any.whl

tinyurl_sdk/__init__.py

@@ -0,0 +1,3 @@
+from .client import TinyURLClient
+
+__all__ = ["TinyURLClient"]

tinyurl_sdk/client.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+import httpx
+
+from .exceptions import TinyURLClientError, TinyURLHTTPError, TinyURLResponseError
+
+@dataclass
+class TinyURLClient:
+    api_key: str
+    timeout: float = 10.0
+    api_base_url: str = "https://api.tinyurl.com"
+    user_agent: str = "tinyurl-sdk/0.0.0"
+
+    def shorten(
+        self,
+        url: str,
+        domain: Optional[str] = None,
+        alias: Optional[str] = None,
+        tags: Optional[str] = None,
+        expires_at: Optional[str] = None,
+        description: Optional[str] = None,
+    ) -> str:
+        """Create a TinyURL short link for the provided long URL."""
+        if not url:
+            raise ValueError("url is required")
+        if alias is not None and len(alias) < 5:
+            raise ValueError("alias must be at least 5 characters long")
+
+        return self._shorten_token(
+            url,
+            domain=domain,
+            alias=alias,
+            tags=tags,
+            expires_at=expires_at,
+            description=description,
+        )
+
+    def _shorten_token(
+        self,
+        url: str,
+        domain: Optional[str] = None,
+        alias: Optional[str] = None,
+        tags: Optional[str] = None,
+        expires_at: Optional[str] = None,
+        description: Optional[str] = None,
+    ) -> str:
+        if not self.api_key:
+            raise TinyURLClientError("api_key is required for token API usage")
+        if alias is not None and len(alias) < 5:
+            raise ValueError("alias must be at least 5 characters long")
+
+        payload = {"url": url}
+        if domain:
+            payload["domain"] = domain
+        if alias:
+            payload["alias"] = alias
+        if tags:
+            payload["tags"] = tags
+        if expires_at:
+            payload["expires_at"] = expires_at
+        if description:
+            payload["description"] = description
+
+        url = f"{self.api_base_url.rstrip('/')}/create"
+        headers = {"Authorization": f"Bearer {self.api_key}"}
+
+        try:
+            with httpx.Client(
+                timeout=self.timeout,
+                headers={"User-Agent": self.user_agent},
+            ) as client:
+                response = client.post(url, json=payload, headers=headers)
+                response.raise_for_status()
+                data = response.json()
+        except httpx.HTTPStatusError as exc:
+            raise TinyURLHTTPError(
+                f"HTTP error {exc.response.status_code}: {exc.response.reason_phrase}"
+            ) from exc
+        except httpx.RequestError as exc:
+            raise TinyURLHTTPError(f"Network error: {exc}") from exc
+        except ValueError as exc:
+            raise TinyURLResponseError("Token API did not return valid JSON") from exc
+
+        tiny_url = data.get("data", {}).get("tiny_url")
+        if not tiny_url:
+            raise TinyURLResponseError("Token API response missing tiny_url")
+
+        return tiny_url

tinyurl_sdk/exceptions.py

@@ -0,0 +1,10 @@
+class TinyURLClientError(Exception):
+    """Base error for TinyURL client operations."""
+
+
+class TinyURLHTTPError(TinyURLClientError):
+    """Raised when the HTTP layer fails or returns a non-200 response."""
+
+
+class TinyURLResponseError(TinyURLClientError):
+    """Raised when the API response is missing expected fields."""

tinyurl_sdk-0.1.1.dist-info/METADATA

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: tinyurl-sdk
+Version: 0.1.1
+Summary: Simplifying TinyURL link creation and management with a lightweight Python SDK.
+Project-URL: Homepage, https://github.com/bilalbaraz/tinyurl-sdk
+Project-URL: Repository, https://github.com/bilalbaraz/tinyurl-sdk
+Author-email: Bilal Baraz <bilalbaraz@windowslive.com>
+License: MIT
+License-File: LICENSE
+Keywords: sdk,shortener,tinyurl,url
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.23.0
+Description-Content-Type: text/markdown
+
+# tinyurl-sdk
+
+A lightweight Python SDK for simplifying TinyURL link creation and management.
+
+## Installation
+
+```bash
+pip install tinyurl-sdk
+```
+
+## Usage
+
+```python
+from tinyurl_sdk.client import TinyURLClient
+
+client = TinyURLClient(api_key="YOUR_API_KEY")
+short_url = client.shorten(
+    url="https://www.example.com/my-really-long-link-that-I-need-to-shorten/84378949",
+    domain="tinyurl.com",
+    alias="myexamplelink",
+    tags="example,link",
+    expires_at="2024-10-25 10:11:12",
+    description="string",
+)
+print(short_url)
+```
+
+### Parameters
+
+Constructor:
+
+| Name | Required | Type | Notes |
+| --- | --- | --- | --- |
+| `api_key` | Yes | `str` | TinyURL API key. |
+| `timeout` | No | `float` | Request timeout in seconds. Default: `10.0`. |
+| `api_base_url` | No | `str` | Base API URL. Default: `https://api.tinyurl.com`. |
+| `user_agent` | No | `str` | User agent header. Default: `tinyurl-sdk/0.0.0`. |
+
+`shorten`:
+
+| Name | Required | Type | Notes |
+| --- | --- | --- | --- |
+| `url` | Yes | `str` | Long URL to shorten. |
+| `domain` | No | `str` | TinyURL domain. |
+| `alias` | No | `str` | Must be at least 5 characters if provided. |
+| `tags` | No | `str` | Comma-separated tags. |
+| `expires_at` | No | `str` | Expiration timestamp (API format). |
+| `description` | No | `str` | Link description. |
+
+## Development
+
+```bash
+pip install -e .
+```
+
+## License
+
+MIT

tinyurl_sdk-0.1.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+tinyurl_sdk/__init__.py,sha256=X4v54Iet7xfzcxvie-HnoYYvQTvYq13SthKDFvJhjk0,62
+tinyurl_sdk/client.py,sha256=aKoyYECxMNyU1fV5fxorl4zJ_tzT0dkHcAFAqpwPEtE,2982
+tinyurl_sdk/exceptions.py,sha256=Ftma22lr0BMWpyAD4mDfGNB_9EbjBQ8QUK9e2C14LWI,326
+tinyurl_sdk-0.1.1.dist-info/METADATA,sha256=ce4D0vwMIGU8r-3xfR8M5ib5nSXlDrIdD1QAyZGi1xE,1881
+tinyurl_sdk-0.1.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+tinyurl_sdk-0.1.1.dist-info/licenses/LICENSE,sha256=ESYyLizI0WWtxMeS7rGVcX3ivMezm-HOd5WdeOh-9oU,1056
+tinyurl_sdk-0.1.1.dist-info/RECORD,,

tinyurl_sdk-0.1.1.dist-info/WHEEL

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

tinyurl_sdk-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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.