SEE Python SDK

A modern Python SDK for SEE Content Sharing services (Short URL, Text, File, etc.), featuring async support, full type safety, and Python 3.11+ capabilities.

• 🚀 Modern Python: Built with Python 3.11+ features (type hints, pattern matching, dataclasses)
• 🔄 Async First: Fully async API based on asyncio and httpx
• 📝 Type Safe: 100% type annotated with mypy strict mode support
• 🛡️ Reliable: Built-in retry mechanism, error handling, and rate limiting
• 🧪 Well Tested: Comprehensive test suite with pytest
• 📦 Standard Compliant: Follows PEP 517/518 with pyproject.toml

• Python 3.11+
• httpx >= 0.27.0

pip install see-sdk

or you can visit PyPI page for more options.

Install from source:

git clone https://github.com/sdotee/sdk.py see-python-sdk
cd see-python-sdk && pip install -e .

Set your API key as an environment variable:

export SEE_API_KEY="your-api-key-here"

See examples/url_shortening.py for a simple example of how to create a short URL.

The examples directory contains comprehensive usage examples for all features:

• Quick Start: examples/url_shortening.py - Basic usage for Short URLs.
• Short URLs: examples/url_shortening_complete.py - Advanced Short URL features (custom slugs, tags, expiration).
• Text Sharing: examples/text_sharing.py - Creating, updating, and deleting shared text.
• File Sharing: examples/file_sharing.py - Uploading and managing files.
• Advanced Usage: examples/url_shortening_advanced.py - Complex workflows and resource management.

git clone https://github.com/yourusername/see-sdk.git
cd see-sdk

python -m venv venv
source venv/bin/activate  # Linux/macOS

pip install -e ".[dev]"
pre-commit install

pytest
pytest --cov=see --cov-report=html
pytest tests/test_client.py

black src/ tests/
ruff check src/ tests/
mypy src/

Main client class for API interactions.

• create_short_url(request) - Create short URL
• update_short_url(request) - Update short URL
• delete_short_url(request) - Delete short URL
• create_short_url_simple(url, ...) - Create a short URL using query parameters
• get_link_history(page) - Get short URL history
• get_link_visit_stat(domain, slug, period) - Get link visit statistics
• create_text(request) / update_text(request) / delete_text(request) - Manage shared text
• get_text_history(page) - Get shared text history
• upload_file(path, domain, custom_slug) - Upload a file
• get_file_history(page) - Get file history
• get_private_file_download_url(file_id) - Get a temporary private download URL
• create_large_file_upload(request) - Create a resumable large-file upload session
• upload_large_file_chunk(upload_id, chunk, offset) - Upload a TUS chunk
• complete_large_file_upload(upload_id) - Complete a large-file upload
• create_bio_page(request) / update_bio_page(request) / delete_bio_page(request) - Manage bio pages
• create_qrcode(request) / delete_qrcode(request) - Manage dynamic QR codes
• check_token(token) - Validate an API token
• get_usage() - Get account usage and limits
• get_domains() - Get available domains
• get_tags() - Get available tags

from see import SeeClient
from see.models import CreateLargeFileUploadRequest

async with SeeClient(api_key="your-api-key") as client:
    session = await client.create_large_file_upload(
        CreateLargeFileUploadRequest(file_name="video.mp4", file_size=len(content))
    )
    await client.upload_large_file_chunk(session.data.upload_id, content, offset=0)
    result = await client.complete_large_file_upload(session.data.upload_id)

@dataclass
class CreateShortUrlRequest:
    domain: str
    target_url: str
    title: str
    custom_slug: str | None = None
    expire_at: int | None = None
    tag_ids: list[int] | None = None

• SeeError - Base exception
• APIError - API error
• AuthenticationError - Authentication error
• ValidationError - Validation error
• RateLimitError - Rate limit error
• NotFoundError - Not found error

Contributions are welcome! See CONTRIBUTING.md for details.

MIT License - see LICENSE file.