tsf-sh 1.0.1__py3-none-any.whl

tsf_sh-1.0.1.dist-info/METADATA

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: tsf-sh
+Version: 1.0.1
+Summary: Асинхронная Python библиотека для работы с tsf.sh API
+Home-page: https://tsf.sh
+Author: Towux
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.24.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# tsf-sh
+
+Асинхронная Python библиотека для работы с [tsf.sh](https://tsf.sh) API - сервисом для сокращения ссылок.
+
+## Установка
+
+```bash
+pip install tsf-sh
+```
+
+## Требования
+
+- Python 3.8+
+- httpx 0.24.0+
+
+## Быстрый старт
+
+```python
+import asyncio
+from tsf_sh import Client
+
+async def main():
+    # Инициализация клиента
+    client = Client(api_key="your-api-key")
+    
+    # Создание короткой ссылки
+    link = await client.create_link(
+        url="https://example.com",
+        ttl_hours=24
+    )
+    print(f"Создана ссылка: {link.short_url}")
+    
+    # Получение информации о ссылке
+    link_info = await client.get_link(link.code)
+    print(f"Переходов: {link_info.clicks}")
+    
+    # Закрытие клиента
+    await client.close()
+
+asyncio.run(main())
+```
+
+## Использование с контекстным менеджером
+
+```python
+import asyncio
+from tsf_sh import Client
+
+async def main():
+    async with Client(api_key="your-api-key") as client:
+        # Создание ссылки
+        link = await client.create_link("https://example.com")
+        print(f"Ссылка: {link.short_url}")
+        
+        # Получение списка всех ссылок
+        links = await client.get_links()
+        print(f"Всего ссылок: {len(links)}")
+        
+        # Получение статистики
+        stats = await client.get_stats()
+        print(f"Всего переходов: {stats.total_clicks}")
+
+asyncio.run(main())
+```
+
+## API методы
+
+### Создание ссылки
+
+```python
+link = await client.create_link(
+    url="https://example.com",
+    ttl_hours=24,  # Время жизни в часах (1-24)
+    password="optional_password"  # Опциональный пароль
+)
+```
+
+### Получение списка ссылок
+
+```python
+links = await client.get_links()
+# Список отсортирован по дате создания (новые первые)
+```
+
+### Получение информации о ссылке
+
+```python
+link = await client.get_link("abc123")
+print(f"URL: {link.original_url}")
+print(f"Переходов: {link.clicks}")
+print(f"Истекает: {link.expires_datetime}")
+```
+
+### Удаление ссылки
+
+```python
+await client.delete_link("abc123")
+```
+
+### Продление времени жизни ссылки
+
+```python
+link = await client.extend_link("abc123", ttl_hours=24)
+# TTL устанавливается от текущего момента
+```
+
+### Установка пароля
+
+```python
+await client.set_password("abc123", "my_password")
+```
+
+### Удаление пароля
+
+```python
+await client.remove_password("abc123")
+```
+
+### Перегенерация кода ссылки
+
+```python
+new_code = await client.reroll_code("abc123")
+print(f"Новый код: {new_code}")
+```
+
+### Получение статистики
+
+```python
+stats = await client.get_stats()
+print(f"Активных ссылок: {stats.links_count}")
+print(f"Всего переходов: {stats.total_clicks}")
+```
+
+### Проверка здоровья API
+
+```python
+health = await client.health_check()
+print(f"Статус: {health.status}")
+print(f"Redis: {health.services['redis']}")
+```
+
+## Модели данных
+
+### Link
+
+```python
+link.code              # Код ссылки
+link.short_url         # Короткая ссылка
+link.original_url      # Оригинальный URL
+link.clicks            # Количество переходов
+link.ttl_seconds       # Время жизни в секундах
+link.created_at        # Unix timestamp создания
+link.expires_at        # Unix timestamp истечения
+link.has_password      # Наличие пароля
+link.created_datetime   # datetime объект для created_at
+link.expires_datetime  # datetime объект для expires_at
+link.is_expired        # Проверка истечения
+link.remaining_seconds # Оставшееся время жизни
+```
+
+### LinkStats
+
+```python
+stats.links_count   # Количество активных ссылок
+stats.total_clicks  # Всего переходов
+```
+
+### HealthStatus
+
+```python
+health.status      # "healthy" или "degraded"
+health.services    # Словарь со статусами сервисов
+health.is_healthy  # True если API здоров
+```
+
+## Обработка ошибок
+
+Библиотека выбрасывает специфичные исключения для разных типов ошибок:
+
+```python
+from tsf_sh import (
+    ValidationError,      # 400 - Ошибка валидации
+    UnauthorizedError,     # 401 - Неверный API ключ
+    ForbiddenError,        # 403 - Требуется премиум
+    NotFoundError,         # 404 - Ресурс не найден
+    ConflictError,         # 409 - Конфликт (ссылка уже существует)
+    RateLimitError,        # 429 - Превышен лимит запросов
+    InternalServerError   # 500 - Внутренняя ошибка сервера
+)
+
+try:
+    link = await client.create_link("invalid-url")
+except ValidationError as e:
+    print(f"Ошибка валидации: {e.message}")
+except ConflictError as e:
+    print(f"Ссылка уже существует: {e.existing_code}")
+except RateLimitError as e:
+    print(f"Лимит превышен. Попробуйте через {e.reset_time} секунд")
+```
+
+## Получение API ключа
+
+API ключ можно получить в Telegram боте [@tsf_sh_bot](https://t.me/tsf_sh_bot) в разделе профиля, но только после покупки премиума. Премиум покупается навсегда.
+
+## Лицензия
+
+MIT
+
+## Ссылки
+
+- [Документация API](https://tsf.sh/api/docs)
+- [Telegram бот](https://t.me/tsf_sh_bot)
+

tsf_sh-1.0.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+tests/__init__.py,sha256=SsNyijrCMUFgNu0GcJr1MAzRn0hxMd7eYjeYwiVHc_I,59
+tests/test_client.py,sha256=tLbyXAYCS7dqEpihCJdVjSqxySilM2Zj_5XVqN-4OIs,26439
+tsf_sh/__init__.py,sha256=CASxuiCk2ibcsjkPt21Wk8wXqo4zF8wbf1IioX7gDHc,670
+tsf_sh/client.py,sha256=ZRApcPiY6KZbjQlrdSyF6gIi08xsCKsTG3WxUSPCjvA,12550
+tsf_sh/exceptions.py,sha256=pY9yABA2kXL_Zn8OsHc4F3hy_L3HS_KckF3I0MiFp-c,2186
+tsf_sh/models.py,sha256=ZkUb_4dM6jlMHQulKkcxR4c-4KwwGZgNCo1_p9HEgBk,2742
+tsf_sh-1.0.1.dist-info/METADATA,sha256=fNnB3H0cccoj-axOFgEwr3ZWVJs-GmKCPwR7GD20lgA,7319
+tsf_sh-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+tsf_sh-1.0.1.dist-info/top_level.txt,sha256=JcscsZMfZac3ie7Dd8z-N1wHhuZx3YjdJTJDPsresJs,13
+tsf_sh-1.0.1.dist-info/RECORD,,

tsf_sh-1.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

tsf_sh-1.0.1.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+tests
+tsf_sh