channel3-sdk 0.2.2__tar.gz → 1.0.0__tar.gz

channel3_sdk-0.2.2/README.md → channel3_sdk-1.0.0/PKG-INFO

@@ -1,3 +1,31 @@
+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.
@@ -39,10 +67,7 @@ if product_detail.key_features:
 
 # Get all brands
 brands = client.get_brands()
-for brand in brands:
-    print(f"Brand: {brand.name}")
-    if brand.description:
-        print(f"Description: {brand.description}")
+print(f"Found {len(brands.items)} brands")
 
 # Get specific brand details
 brand = client.get_brand("brand_123")
@@ -58,23 +83,23 @@ 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)} brands")
+    print(f"Found {len(brands.items)} brands")
 
 # Run the async function
 asyncio.run(main())
@@ -126,11 +151,39 @@ products = client.search(
 )
 ```
 
+### 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")
@@ -146,26 +199,31 @@ print(f"Logo: {brand_detail.logo_url}")
 ### Client Classes
 
 #### `Channel3Client`
+
 Synchronous client for the Channel3 API.
 
 **Methods:**
-- `search(query=None, image_url=None, base64_image=None, filters=None, limit=20)` → `List[Product]`
+
+- `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)` → `List[Brand]`
+- `get_brands(query=None, page=1, size=100)` → `PaginatedResponseBrand`
 - `get_brand(brand_id)` → `Brand`
 
-#### `AsyncChannel3Client` 
+#### `AsyncChannel3Client`
+
 Asynchronous client for the Channel3 API.
 
 **Methods:**
-- `async search(query=None, image_url=None, base64_image=None, filters=None, limit=20)` → `List[Product]`
+
+- `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)` → `List[Brand]`
+- `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
@@ -177,6 +235,7 @@ Asynchronous client for the Channel3 API.
 - `variants: List[Variant]` - Product variants
 
 #### `ProductDetail`
+
 - `title: str` - Product title
 - `description: Optional[str]` - Product description
 - `brand_id: Optional[str]` - Brand identifier
@@ -188,34 +247,57 @@ Asynchronous client for the Channel3 API.
 - `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:
@@ -249,11 +331,11 @@ except Channel3ConnectionError:
 
 ## Requirements
 
-- Python 3.8+
+- Python 3.9+
 - requests
-- aiohttp
-- pydantic
+- httpx
 
 ## License
 
 MIT License
+

channel3_sdk-0.2.2/PKG-INFO → channel3_sdk-1.0.0/README.md

@@ -1,27 +1,3 @@
-Metadata-Version: 2.1
-Name: channel3-sdk
-Version: 0.2.2
-Summary: The official Python SDK for Channel3 AI Shopping API
-Home-page: https://github.com/channel3/sdk-python
-License: MIT
-Keywords: ai,shopping,ecommerce,search,api
-Author: Channel3
-Author-email: alex@trychannel3.com
-Requires-Python: >=3.8,<4.0
-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
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: aiohttp (>=3.9.0,<4.0.0)
-Requires-Dist: pydantic (>=2.5.0,<3.0.0)
-Requires-Dist: requests (>=2.31.0,<3.0.0)
-Project-URL: Repository, https://github.com/channel3/sdk-python
-Description-Content-Type: text/markdown
-
 # Channel3 Python SDK
 
 The official Python SDK for the [Channel3](https://trychannel3.com) AI Shopping API.
@@ -63,10 +39,7 @@ if product_detail.key_features:
 
 # Get all brands
 brands = client.get_brands()
-for brand in brands:
-    print(f"Brand: {brand.name}")
-    if brand.description:
-        print(f"Description: {brand.description}")
+print(f"Found {len(brands.items)} brands")
 
 # Get specific brand details
 brand = client.get_brand("brand_123")
@@ -82,23 +55,23 @@ 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)} brands")
+    print(f"Found {len(brands.items)} brands")
 
 # Run the async function
 asyncio.run(main())
@@ -150,11 +123,39 @@ products = client.search(
 )
 ```
 
+### 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")
@@ -170,26 +171,31 @@ print(f"Logo: {brand_detail.logo_url}")
 ### Client Classes
 
 #### `Channel3Client`
+
 Synchronous client for the Channel3 API.
 
 **Methods:**
-- `search(query=None, image_url=None, base64_image=None, filters=None, limit=20)` → `List[Product]`
+
+- `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)` → `List[Brand]`
+- `get_brands(query=None, page=1, size=100)` → `PaginatedResponseBrand`
 - `get_brand(brand_id)` → `Brand`
 
-#### `AsyncChannel3Client` 
+#### `AsyncChannel3Client`
+
 Asynchronous client for the Channel3 API.
 
 **Methods:**
-- `async search(query=None, image_url=None, base64_image=None, filters=None, limit=20)` → `List[Product]`
+
+- `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)` → `List[Brand]`
+- `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
@@ -201,6 +207,7 @@ Asynchronous client for the Channel3 API.
 - `variants: List[Variant]` - Product variants
 
 #### `ProductDetail`
+
 - `title: str` - Product title
 - `description: Optional[str]` - Product description
 - `brand_id: Optional[str]` - Brand identifier
@@ -212,34 +219,57 @@ Asynchronous client for the Channel3 API.
 - `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:
@@ -273,12 +303,10 @@ except Channel3ConnectionError:
 
 ## Requirements
 
-- Python 3.8+
+- Python 3.9+
 - requests
-- aiohttp
-- pydantic
+- httpx
 
 ## License
 
 MIT License
-

channel3_sdk-1.0.0/channel3_sdk/__init__.py

@@ -0,0 +1,52 @@
+"""Channel3 SDK for Python - Official SDK for the Channel3 AI Shopping API."""
+
+from ._gen.fast_api_client.models.availability_status import AvailabilityStatus
+from ._gen.fast_api_client.models.brand import Brand
+from ._gen.fast_api_client.models.paginated_response_brand import (
+    PaginatedResponseBrand,
+)
+
+# Re-export generated models so the public API returns exactly what the OpenAPI returns
+from ._gen.fast_api_client.models.pagination_meta import PaginationMeta
+from ._gen.fast_api_client.models.price import Price
+from ._gen.fast_api_client.models.product import Product
+from ._gen.fast_api_client.models.product_detail import ProductDetail
+from ._gen.fast_api_client.models.search_config import SearchConfig
+from ._gen.fast_api_client.models.search_filters import SearchFilters
+from ._gen.fast_api_client.models.search_request import SearchRequest
+from ._gen.fast_api_client.models.variant import Variant
+from .client import AsyncChannel3Client, Channel3Client
+from .exceptions import (
+    Channel3AuthenticationError,
+    Channel3ConnectionError,
+    Channel3Error,
+    Channel3NotFoundError,
+    Channel3ServerError,
+    Channel3ValidationError,
+)
+
+__version__ = "1.0.0"
+__all__ = [
+    # Clients
+    "Channel3Client",
+    "AsyncChannel3Client",
+    # Models (generated)
+    "Product",
+    "ProductDetail",
+    "SearchFilters",
+    "SearchConfig",
+    "SearchRequest",
+    "Brand",
+    "Variant",
+    "Price",
+    "AvailabilityStatus",
+    "PaginatedResponseBrand",
+    "PaginationMeta",
+    # Exceptions
+    "Channel3Error",
+    "Channel3AuthenticationError",
+    "Channel3ValidationError",
+    "Channel3NotFoundError",
+    "Channel3ServerError",
+    "Channel3ConnectionError",
+]

channel3_sdk-1.0.0/channel3_sdk/_gen/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage

channel3_sdk-1.0.0/channel3_sdk/_gen/README.md

@@ -0,0 +1,124 @@
+# fast-api-client
+A client library for accessing FastAPI
+
+## Usage
+First, create a client:
+
+```python
+from fast_api_client import Client
+
+client = Client(base_url="https://api.example.com")
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from fast_api_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from fast_api_client.models import MyDataModel
+from fast_api_client.api.my_tag import get_my_data_model
+from fast_api_client.types import Response
+
+with client as client:
+    my_data: MyDataModel = get_my_data_model.sync(client=client)
+    # or if you need more info (e.g. status_code)
+    response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+```
+
+Or do the same thing with an async version:
+
+```python
+from fast_api_client.models import MyDataModel
+from fast_api_client.api.my_tag import get_my_data_model
+from fast_api_client.types import Response
+
+async with client as client:
+    my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
+    response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken",
+    verify_ssl="/path/to/certificate_bundle.pem",
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken", 
+    verify_ssl=False
+)
+```
+
+Things to know:
+1. Every path/method combo becomes a Python module with four functions:
+    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+    1. `asyncio`: Like `sync` but async instead of blocking
+    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `fast_api_client.api.default`
+
+## Advanced customizations
+
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from fast_api_client import Client
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+client = Client(
+    base_url="https://api.example.com",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import httpx
+from fast_api_client import Client
+
+client = Client(
+    base_url="https://api.example.com",
+)
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030"))
+```
+
+## Building / publishing this package
+This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
+1. Update the metadata in pyproject.toml (e.g. authors, version)
+1. If you're using a private repository, configure it with Poetry
+    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
+    1. `poetry config http-basic.<your-repository-name> <username> <password>`
+1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
+
+If you want to install this client into another project without publishing it (e.g. for development) then:
+1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
+1. If that project is not using Poetry:
+    1. Build a wheel with `poetry build -f wheel`
+    1. Install that wheel from the other project `pip install <path-to-wheel>`

channel3_sdk-1.0.0/channel3_sdk/_gen/fast_api_client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing FastAPI"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

channel3_sdk-1.0.0/channel3_sdk/_gen/fast_api_client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

channel3_sdk-1.0.0/channel3_sdk/_gen/fast_api_client/api/channel3_api/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""