channel3-sdk 1.0.0__py3-none-any.whl → 2.1.0__py3-none-any.whl

channel3_sdk-1.0.0.dist-info/METADATA

@@ -1,341 +0,0 @@
-Metadata-Version: 2.1
-Name: channel3-sdk
-Version: 1.0.0
-Summary: The official Python SDK for Channel3
-Home-page: https://github.com/channel3-ai/sdk-python
-License: MIT
-Keywords: ai,shopping,ecommerce,search,api
-Author: Channel3
-Author-email: alex@trychannel3.com
-Requires-Python: >=3.9,<4.0
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Typing :: Typed
-Requires-Dist: attrs (>=22.2.0)
-Requires-Dist: httpx (>=0.23.0,<0.29.0)
-Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
-Requires-Dist: requests (>=2.31.0,<3.0.0)
-Project-URL: Repository, https://github.com/channel3-ai/sdk-python
-Description-Content-Type: text/markdown
-
-# Channel3 Python SDK
-
-The official Python SDK for the [Channel3](https://trychannel3.com) AI Shopping API.
-
-## Installation
-
-```bash
-pip install channel3-sdk
-```
-
-## Quick Start
-
-### Synchronous Client
-
-```python
-import os
-from channel3_sdk import Channel3Client
-
-# Initialize the client
-client = Channel3Client(api_key="your_api_key_here")
-# Or use environment variable: CHANNEL3_API_KEY
-
-# Search for products
-products = client.search(query="blue denim jacket")
-
-for product in products:
-    print(f"Product: {product.title}")
-    print(f"Brand: {product.brand_name}")
-    print(f"Price: {product.price.currency} {product.price.price}")
-    print(f"Availability: {product.availability}")
-    print("---")
-
-# Get detailed product information
-product_detail = client.get_product("prod_123456")
-print(f"Detailed info for: {product_detail.title}")
-print(f"Brand: {product_detail.brand_name}")
-if product_detail.key_features:
-    print(f"Key features: {product_detail.key_features}")
-
-# Get all brands
-brands = client.get_brands()
-print(f"Found {len(brands.items)} brands")
-
-# Get specific brand details
-brand = client.get_brand("brand_123")
-print(f"Brand: {brand.name}")
-```
-
-### Asynchronous Client
-
-```python
-import asyncio
-from channel3_sdk import AsyncChannel3Client
-
-async def main():
-    # Initialize the async client
-    client = AsyncChannel3Client(api_key="your_api_key_here")
-
-    # Search for products
-    products = await client.search(query="running shoes")
-
-    for product in products:
-        print(f"Product: {product.title}")
-        print(f"Score: {product.score}")
-        print(f"Price: {product.price.currency} {product.price.price}")
-
-    # Get detailed product information
-    if products:
-        product_detail = await client.get_product(products[0].id)
-        print(f"Availability: {product_detail.availability}")
-
-    # Get brands
-    brands = await client.get_brands()
-    print(f"Found {len(brands.items)} brands")
-
-# Run the async function
-asyncio.run(main())
-```
-
-## Advanced Usage
-
-### Visual Search
-
-```python
-# Search by image URL
-products = client.search(image_url="https://example.com/image.jpg")
-
-# Search by base64 image
-with open("image.jpg", "rb") as f:
-    import base64
-    base64_image = base64.b64encode(f.read()).decode()
-    products = client.search(base64_image=base64_image)
-```
-
-### Multimodal Search
-
-```python
-# Combine text and image search
-products = client.search(
-    query="blue denim jacket",
-    image_url="https://example.com/jacket.jpg"
-)
-```
-
-### Search with Filters
-
-```python
-from channel3_sdk import SearchFilters, AvailabilityStatus
-
-# Create search filters
-filters = SearchFilters(
-    brand_ids=["brand_123", "brand_456"],
-    gender="male",
-    availability=[AvailabilityStatus.IN_STOCK],
-    price={"min_price": 50.0, "max_price": 200.0}
-)
-
-# Search with filters
-products = client.search(
-    query="jacket",
-    filters=filters,
-    limit=10
-)
-```
-
-### Search configuration and context
-
-You can control how search behaves using `SearchConfig`, and add optional `context` to guide results.
-
-```python
-from channel3_sdk import SearchConfig
-
-config = SearchConfig(enrich_query=True, semantic_search=False)
-
-products = client.search(
-    query="running shoes",
-    limit=5,
-    config=config,              # or a dict: {"enrich_query": True, "semantic_search": False}
-    context="Marathon training on road surfaces"
-)
-```
-
-Async usage is identical:
-
-```python
-products = await async_client.search(
-    query="hiking boots",
-    config={"enrich_query": False, "semantic_search": True},
-    context="Waterproof boots for alpine conditions"
-)
-```
-
-### Brand Management
-
-```python
-# Get all brands with pagination
-brands = client.get_brands(page=1, size=50)
-print(brands.pagination.total_count)
-
-# Search for specific brands
-nike_brands = client.get_brands(query="nike")
-
-# Get detailed brand information
-brand_detail = client.get_brand("brand_123")
-print(f"Brand: {brand_detail.name}")
-print(f"Logo: {brand_detail.logo_url}")
-```
-
-## API Reference
-
-### Client Classes
-
-#### `Channel3Client`
-
-Synchronous client for the Channel3 API.
-
-**Methods:**
-
-- `search(query=None, image_url=None, base64_image=None, filters=None, limit=20, config=None, context=None)` → `List[Product]`
-- `get_product(product_id)` → `ProductDetail`
-- `get_brands(query=None, page=1, size=100)` → `PaginatedResponseBrand`
-- `get_brand(brand_id)` → `Brand`
-
-#### `AsyncChannel3Client`
-
-Asynchronous client for the Channel3 API.
-
-**Methods:**
-
-- `async search(query=None, image_url=None, base64_image=None, filters=None, limit=20, config=None, context=None)` → `List[Product]`
-- `async get_product(product_id)` → `ProductDetail`
-- `async get_brands(query=None, page=1, size=100)` → `PaginatedResponseBrand`
-- `async get_brand(brand_id)` → `Brand`
-
-### Models
-
-#### `Product`
-
-- `id: str` - Unique product identifier
-- `score: float` - Search relevance score
-- `title: str` - Product title
-- `description: Optional[str]` - Product description
-- `brand_name: str` - Brand name
-- `image_url: str` - Main product image URL
-- `price: Price` - Price information
-- `availability: AvailabilityStatus` - Availability status
-- `variants: List[Variant]` - Product variants
-
-#### `ProductDetail`
-
-- `title: str` - Product title
-- `description: Optional[str]` - Product description
-- `brand_id: Optional[str]` - Brand identifier
-- `brand_name: Optional[str]` - Brand name
-- `image_urls: Optional[List[str]]` - Product image URLs
-- `price: Price` - Price information
-- `availability: AvailabilityStatus` - Availability status
-- `key_features: Optional[List[str]]` - Key product features
-- `variants: List[Variant]` - Product variants
-
-#### `Brand`
-
-- `id: str` - Unique brand identifier
-- `name: str` - Brand name
-- `logo_url: Optional[str]` - Brand logo URL
-- `description: Optional[str]` - Brand description
-
-#### `Variant`
-
-- `product_id: str` - Associated product identifier
-- `title: str` - Variant title
-- `image_url: str` - Variant image URL
-
-#### `SearchFilters`
-
-- `brand_ids: Optional[List[str]]` - Brand ID filters
-- `gender: Optional[Literal["male", "female", "unisex"]]` - Gender filter
-- `price: Optional[SearchFilterPrice]` - Price range filter
-- `availability: Optional[List[AvailabilityStatus]]` - Availability filters
-
-#### `SearchFilterPrice`
-
-- `min_price: Optional[float]` - Minimum price
-- `max_price: Optional[float]` - Maximum price
-
-#### `SearchConfig`
-
-- `enrich_query: bool = True` — enable query rewriting/enrichment
-- `semantic_search: bool = True` — enable semantic ranking
-
-#### `Price`
-
-- `price: float` - Current price
-- `compare_at_price: Optional[float]` - Original price (if discounted)
-- `currency: str` - Currency code
-
-#### `AvailabilityStatus`
-
-Enum with values: `IN_STOCK`, `OUT_OF_STOCK`, `PRE_ORDER`, `LIMITED_AVAILABILITY`, `BACK_ORDER`, `DISCONTINUED`, `SOLD_OUT`, `UNKNOWN`
-
-#### `PaginatedResponseBrand`
-
-- `items: List[Brand]` — page of brands
-- `pagination: PaginationMeta` — pagination info
-
-#### `PaginationMeta`
-
-- `current_page: int`
-- `page_size: int`
-- `total_count: int`
-- `total_pages: int`
-
-## Error Handling
-
-The SDK provides specific exception types for different error conditions:
-
-```python
-from channel3_sdk import (
-    Channel3AuthenticationError,
-    Channel3ValidationError,
-    Channel3NotFoundError,
-    Channel3ServerError,
-    Channel3ConnectionError
-)
-
-try:
-    products = client.search(query="shoes")
-except Channel3AuthenticationError:
-    print("Invalid API key")
-except Channel3ValidationError as e:
-    print(f"Invalid request: {e.message}")
-except Channel3NotFoundError:
-    print("Resource not found")
-except Channel3ServerError:
-    print("Server error - please try again later")
-except Channel3ConnectionError:
-    print("Connection error - check your internet connection")
-```
-
-## Environment Variables
-
-- `CHANNEL3_API_KEY` - Your Channel3 API key
-
-## Requirements
-
-- Python 3.9+
-- requests
-- httpx
-
-## License
-
-MIT License
-

channel3_sdk-1.0.0.dist-info/RECORD

@@ -1,38 +0,0 @@
-channel3_sdk/__init__.py,sha256=mYmvZ2ahuAxzy_1gtroB8qpK_u_tuKoDCm5C_LHRwRg,1696
-channel3_sdk/_gen/.gitignore,sha256=SwZvl9qyKaHN9YjwaQrBsmpAclN11usf9Gohz1SFVg8,195
-channel3_sdk/_gen/README.md,sha256=d6VMPYuhTiK-WEKNRd-zbIG_uzYOVWkVvPBgDEPVwnc,4997
-channel3_sdk/_gen/fast_api_client/__init__.py,sha256=qUheje2C4lZ8b26EUHXHRJ3dWuzKiExv_JVOdVCFAek,150
-channel3_sdk/_gen/fast_api_client/api/__init__.py,sha256=zTSiG_ujSjAqWPyc435YXaX9XTlpMjiJWBbV-f-YtdA,45
-channel3_sdk/_gen/fast_api_client/api/channel3_api/__init__.py,sha256=5vd9uJWAjRqa9xzxzYkLD1yoZ12Ld_bAaNB5WX4fbE8,56
-channel3_sdk/_gen/fast_api_client/api/channel3_api/get_brand_detail_v0_brands_brand_id_get.py,sha256=yNOOiKimIDQONHCH3i5KBnYa1LvEjD6THXjCyLgE-tU,4611
-channel3_sdk/_gen/fast_api_client/api/channel3_api/get_brands_v0_brands_get.py,sha256=KfCOw1595dAcV1IT9Vuddz1EKiaHOb2BBrVcmNsczL0,6075
-channel3_sdk/_gen/fast_api_client/api/channel3_api/get_product_detail_v0_products_product_id_get.py,sha256=8d3Z4CXdph42GcYSjqaVFqz54Ct2D8tqwZ8PXn66Xyo,4778
-channel3_sdk/_gen/fast_api_client/api/channel3_api/search_v0_search_post.py,sha256=TV2_222dJtv8nmVXxGGznB-maWlHZB96nxJAhxQz6T0,4944
-channel3_sdk/_gen/fast_api_client/api/default/__init__.py,sha256=5vd9uJWAjRqa9xzxzYkLD1yoZ12Ld_bAaNB5WX4fbE8,56
-channel3_sdk/_gen/fast_api_client/api/default/root_get.py,sha256=83wq3kzLX9On8L2L8wldOgIf90e5fUsTT6dbC2bvfYM,2063
-channel3_sdk/_gen/fast_api_client/client.py,sha256=o_mdLqyBCQstu5tS1WZFwqIEbGwkvWQ7eQjuCJw_5VY,12419
-channel3_sdk/_gen/fast_api_client/errors.py,sha256=gO8GBmKqmSNgAg-E5oT-oOyxztvp7V_6XG7OUTT15q0,546
-channel3_sdk/_gen/fast_api_client/models/__init__.py,sha256=Yc0J6woL8dLhHW0VZbZuSV17-9DHR-qpk63sC6SiNVc,1059
-channel3_sdk/_gen/fast_api_client/models/availability_status.py,sha256=yC7hCgFwU_CcIfnS2UggdFdNWsoq0lvrdrR5n43tIto,361
-channel3_sdk/_gen/fast_api_client/models/brand.py,sha256=hEObzXznweXyzLjiSQl0pUBYquCrn09XKcFSKtjoQfk,2986
-channel3_sdk/_gen/fast_api_client/models/error_response.py,sha256=hGdOt8lakOZFh9YlOE53zEq9Ektv6cOQTIbqtRLg4TQ,1467
-channel3_sdk/_gen/fast_api_client/models/paginated_response_brand.py,sha256=TPd0tEzvE7TxE7DhpSsh5p4FpP1muHSYQezwZ9Yxcas,2330
-channel3_sdk/_gen/fast_api_client/models/pagination_meta.py,sha256=iF8W1dOyuDb4Y5Wa5HviYfXjPJkayK5R68JgNA7rwY4,2185
-channel3_sdk/_gen/fast_api_client/models/price.py,sha256=aol4R82ffjKvsrzch-P1iw5HwT0FcCqUmGvjb65lPmM,2617
-channel3_sdk/_gen/fast_api_client/models/product.py,sha256=XkKaBA89YOaMh9XSTEdBkvO8miQVED8nNquAO75bw1s,4485
-channel3_sdk/_gen/fast_api_client/models/product_detail.py,sha256=PybK6gS_yxmjIax7ryH6pha69T-iCNR8IjtWHn8cFVU,9850
-channel3_sdk/_gen/fast_api_client/models/product_detail_gender_type_0.py,sha256=iz4Yx9AiuvITYK5r1C_8hUY09GyVtJ7Saru7FdeDGLQ,191
-channel3_sdk/_gen/fast_api_client/models/search_config.py,sha256=nVjpdhESU7IJiCW4HCdq1hUGDVtrhXhFJqrjDgGHzlc,2031
-channel3_sdk/_gen/fast_api_client/models/search_filter_price.py,sha256=GFaLgoXXRkLpX39b3w0JpZRek026DQEp-UfRMaXmMXs,2864
-channel3_sdk/_gen/fast_api_client/models/search_filters.py,sha256=KjioDMmVINN2vR1iCEj7GH9ME6BfmI17a1jgiMyd8xU,6657
-channel3_sdk/_gen/fast_api_client/models/search_filters_gender_type_0.py,sha256=52XYojpfDdj_LV_9gQbsGWP_aANJ1-KiZOogxn4noms,191
-channel3_sdk/_gen/fast_api_client/models/search_request.py,sha256=oqQcXcH1Psp-Qwx8_MFhyPIB60gBMo-IpPnBp24DUmg,6156
-channel3_sdk/_gen/fast_api_client/models/variant.py,sha256=G3T1E5sBZmJb2hYeb9V3ACaUqVBhqX9gRvI_ooHFgVI,1820
-channel3_sdk/_gen/fast_api_client/py.typed,sha256=8ZJUsxZiuOy1oJeVhsTWQhTG_6pTVHVXk5hJL79ebTk,25
-channel3_sdk/_gen/fast_api_client/types.py,sha256=AX4orxQZQJat3vZrgjJ-TYb2sNBL8kNo9yqYDT-n8y8,1391
-channel3_sdk/_gen/pyproject.toml,sha256=m8NKk1ztXdKounkQTmYgzcML-jmumnMdLLielJAam0k,544
-channel3_sdk/client.py,sha256=5yJJiucJiTl-BV_zKaGch57OQSpIEJjWD5TPHaaapl4,13658
-channel3_sdk/exceptions.py,sha256=5HJgrhir4-_b4XKyWAB9qp-CjVZeigXSkyM9fbcB1IA,1044
-channel3_sdk-1.0.0.dist-info/METADATA,sha256=WGfNoiIoxP86MfoglDbOJofwBlLkzhcidBj91Bg1vL8,9028
-channel3_sdk-1.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-channel3_sdk-1.0.0.dist-info/RECORD,,