speedyshortpy 0.1.0__tar.gz

speedyshortpy-0.1.0/LICENSE

@@ -0,0 +1,17 @@
+Prosperity Public License 3.0.0
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of this software and associated documentation files (the
+“Software”), to use, copy, modify, merge, publish, and/or distribute the
+Software for noncommercial purposes only.
+
+Noncommercial purposes include educational, personal, research, and open
+source use.
+
+Commercial use of this Software, including but not limited to using,
+offering for sale, incorporating into a paid service, or distributing for
+commercial gain, requires a commercial license from the copyright holder.
+
+The Software is provided “as is”, without warranty of any kind, express or
+implied, including but not limited to warranties of merchantability, fitness
+for a particular purpose and noninfringement.

speedyshortpy-0.1.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: speedyshortpy
+Version: 0.1.0
+Summary: Python client for the SpeedyShort URL shortener.
+Author: Mauronofrio Matarrese
+License: Prosperity Public License 3.0.0
+Project-URL: Homepage, https://github.com/mauronofrio/SpeedyShort
+Project-URL: Repository, https://github.com/mauronofrio/SpeedyShort
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28
+Dynamic: license-file
+
+# speedyshortpy
+
+`speedyshortpy` is a small Python client for the [SpeedyShort](https://github.com/mauronofrio/SpeedyShort)
+URL shortener.
+
+It provides a thin wrapper around the HTTP API so you can create short links from Python
+code with a single call.
+
+## Installation
+
+Once published on PyPI:
+
+```bash
+pip install speedyshortpy
+```
+
+For local development, you can install it from the cloned repository:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+By default the client targets a local SpeedyShort instance on `http://localhost:8080`:
+
+```python
+from speedyshortpy import SpeedyShortClient
+
+client = SpeedyShortClient()  # base_url="http://localhost:8080"
+
+result = client.shorten("https://www.example.com")
+print(result.code)
+print(result.short_url)
+print(result.target_url)
+```
+
+You can also point it to a remote instance, for example the public demo:
+
+```python
+client = SpeedyShortClient(base_url="https://syrt.cc")
+```
+
+### Resolving a short code
+
+You usually do not need a client for redirects, but if you want to inspect
+the redirect response:
+
+```python
+resp = client.resolve("a7X9pQ", follow_redirects=False)
+print(resp.status_code)
+print(resp.headers.get("Location"))
+```
+
+## License
+
+This client library is released under the same license as the main project:
+**Prosperity Public License 3.0.0**.
+
+Commercial use requires a commercial license from the copyright holder.

speedyshortpy-0.1.0/README.md

@@ -0,0 +1,60 @@
+# speedyshortpy
+
+`speedyshortpy` is a small Python client for the [SpeedyShort](https://github.com/mauronofrio/SpeedyShort)
+URL shortener.
+
+It provides a thin wrapper around the HTTP API so you can create short links from Python
+code with a single call.
+
+## Installation
+
+Once published on PyPI:
+
+```bash
+pip install speedyshortpy
+```
+
+For local development, you can install it from the cloned repository:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+By default the client targets a local SpeedyShort instance on `http://localhost:8080`:
+
+```python
+from speedyshortpy import SpeedyShortClient
+
+client = SpeedyShortClient()  # base_url="http://localhost:8080"
+
+result = client.shorten("https://www.example.com")
+print(result.code)
+print(result.short_url)
+print(result.target_url)
+```
+
+You can also point it to a remote instance, for example the public demo:
+
+```python
+client = SpeedyShortClient(base_url="https://syrt.cc")
+```
+
+### Resolving a short code
+
+You usually do not need a client for redirects, but if you want to inspect
+the redirect response:
+
+```python
+resp = client.resolve("a7X9pQ", follow_redirects=False)
+print(resp.status_code)
+print(resp.headers.get("Location"))
+```
+
+## License
+
+This client library is released under the same license as the main project:
+**Prosperity Public License 3.0.0**.
+
+Commercial use requires a commercial license from the copyright holder.

speedyshortpy-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "speedyshortpy"
+version = "0.1.0"
+description = "Python client for the SpeedyShort URL shortener."
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "Prosperity Public License 3.0.0"}
+authors = [
+    {name = "Mauronofrio Matarrese"}
+]
+
+dependencies = ["requests>=2.28"]
+
+[project.urls]
+Homepage = "https://github.com/mauronofrio/SpeedyShort"
+Repository = "https://github.com/mauronofrio/SpeedyShort"
+
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"

speedyshortpy-0.1.0/setup.cfg

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

speedyshortpy-0.1.0/speedyshortpy/__init__.py

@@ -0,0 +1,7 @@
+"""
+Python client for the SpeedyShort URL shortener.
+"""
+
+from .client import SpeedyShortClient, ShortLink
+
+__all__ = ["SpeedyShortClient", "ShortLink"]

speedyshortpy-0.1.0/speedyshortpy/client.py

@@ -0,0 +1,81 @@
+"""
+Client wrapper for the SpeedyShort URL shortener API.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+import requests
+
+
+@dataclass
+class ShortLink:
+    """Represents a short link created by SpeedyShort."""
+
+    code: str
+    short_url: str
+    target_url: str
+
+
+class SpeedyShortClient:
+    """
+    Simple client for the SpeedyShort HTTP API.
+
+    By default it targets a local instance running on http://localhost:8080,
+    but you can point it to any reachable SpeedyShort installation, for example:
+
+        client = SpeedyShortClient(base_url="https://syrt.cc")
+    """
+
+    def __init__(
+        self,
+        base_url: str = "http://localhost:8080",
+        timeout: float = 5.0,
+    ) -> None:
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self._session = requests.Session()
+
+    @property
+    def session(self) -> requests.Session:
+        return self._session
+
+    def shorten(self, url: str) -> ShortLink:
+        """
+        Create a short link for the given URL.
+
+        :param url: The original long URL.
+        :return: ShortLink with code, short URL and target URL.
+        :raises requests.HTTPError: if the API returns an error.
+        """
+        endpoint = f"{self.base_url}/api/shorten"
+        resp = self._session.post(
+            endpoint,
+            json={"url": url},
+            timeout=self.timeout,
+        )
+        resp.raise_for_status()
+        data = resp.json()
+        return ShortLink(
+            code=data["code"],
+            short_url=data["short_url"],
+            target_url=data["target_url"],
+        )
+
+    def resolve(self, code: str, follow_redirects: bool = False) -> requests.Response:
+        """
+        Perform a GET request for the given short code.
+
+        This is mostly useful if you want to inspect the redirect response.
+        If follow_redirects is False, the Response will usually have status_code 301/302
+        and the target URL in the 'Location' header.
+
+        :param code: Short code (e.g. 'a7X9pQ').
+        :param follow_redirects: Whether to follow redirects automatically.
+        :return: requests.Response
+        """
+        url = f"{self.base_url}/{code.lstrip('/')}"
+        resp = self._session.get(url, timeout=self.timeout, allow_redirects=follow_redirects)
+        return resp

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

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: speedyshortpy
+Version: 0.1.0
+Summary: Python client for the SpeedyShort URL shortener.
+Author: Mauronofrio Matarrese
+License: Prosperity Public License 3.0.0
+Project-URL: Homepage, https://github.com/mauronofrio/SpeedyShort
+Project-URL: Repository, https://github.com/mauronofrio/SpeedyShort
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28
+Dynamic: license-file
+
+# speedyshortpy
+
+`speedyshortpy` is a small Python client for the [SpeedyShort](https://github.com/mauronofrio/SpeedyShort)
+URL shortener.
+
+It provides a thin wrapper around the HTTP API so you can create short links from Python
+code with a single call.
+
+## Installation
+
+Once published on PyPI:
+
+```bash
+pip install speedyshortpy
+```
+
+For local development, you can install it from the cloned repository:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+By default the client targets a local SpeedyShort instance on `http://localhost:8080`:
+
+```python
+from speedyshortpy import SpeedyShortClient
+
+client = SpeedyShortClient()  # base_url="http://localhost:8080"
+
+result = client.shorten("https://www.example.com")
+print(result.code)
+print(result.short_url)
+print(result.target_url)
+```
+
+You can also point it to a remote instance, for example the public demo:
+
+```python
+client = SpeedyShortClient(base_url="https://syrt.cc")
+```
+
+### Resolving a short code
+
+You usually do not need a client for redirects, but if you want to inspect
+the redirect response:
+
+```python
+resp = client.resolve("a7X9pQ", follow_redirects=False)
+print(resp.status_code)
+print(resp.headers.get("Location"))
+```
+
+## License
+
+This client library is released under the same license as the main project:
+**Prosperity Public License 3.0.0**.
+
+Commercial use requires a commercial license from the copyright holder.

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

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+speedyshortpy/__init__.py
+speedyshortpy/client.py
+speedyshortpy.egg-info/PKG-INFO
+speedyshortpy.egg-info/SOURCES.txt
+speedyshortpy.egg-info/dependency_links.txt
+speedyshortpy.egg-info/requires.txt
+speedyshortpy.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

speedyshortpy-0.1.0/speedyshortpy.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.28

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

@@ -0,0 +1 @@
+speedyshortpy