Merge pull request #2 from channel3-ai/release-please--branches--main--changes--next

Stainless SDK

Author: ahs53

.github/workflows/publish-pypi.yml

@@ -28,4 +28,4 @@ jobs:
         run: |
           bash ./bin/publish-pypi
         env:
-          PYPI_TOKEN: ${{ secrets.PUBLIC_SDK_PYPI_TOKEN || secrets.PYPI_TOKEN }}
+          PYPI_TOKEN: ${{ secrets.CHANNEL3_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.github/workflows/release-doctor.yml

@@ -18,4 +18,4 @@ jobs:
         run: |
           bash ./bin/check-release-environment
         env:
-          PYPI_TOKEN: ${{ secrets.PUBLIC_SDK_PYPI_TOKEN || secrets.PYPI_TOKEN }}
+          PYPI_TOKEN: ${{ secrets.CHANNEL3_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.0.2"
+  ".": "2.0.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 6
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/channel3%2Fpublic-sdk-eb8fa9262033b1e81549b926b706237a5796a41b06f00cea2d1e2a3362bd163f.yml
 openapi_spec_hash: 4b6160fcd0267ff62ebd54f5c05c88c6
-config_hash: c94dfdce8fd8d58cbba9af3bbc53aec4
+config_hash: 8e18f4f27ef0200cac8c5ee682f53ab8

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 2.0.0 (2025-09-16)
+
+Full Changelog: [v0.0.2...v2.0.0](https://github.com/channel3-ai/sdk-python/compare/v0.0.2...v2.0.0)
+
+### Features
+
+* **api:** manual updates ([f91f4f1](https://github.com/channel3-ai/sdk-python/commit/f91f4f163ea386464efa5b307ec11b689922493e))
+
+
+### Chores
+
+* update SDK settings ([35e85c7](https://github.com/channel3-ai/sdk-python/commit/35e85c70a123d6dd8b745999388082499562347e))
+
 ## 0.0.2 (2025-09-16)
 
 Full Changelog: [v0.0.1...v0.0.2](https://github.com/channel3-ai/sdk-python/compare/v0.0.1...v0.0.2)

CONTRIBUTING.md

@@ -36,7 +36,7 @@ $ pip install -r requirements-dev.lock
 
 Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
 result in merge conflicts between manual patches and changes from the generator. The generator will never
-modify the contents of the `src/public_sdk/lib/` and `examples/` directories.
+modify the contents of the `src/channel3_sdk/lib/` and `examples/` directories.
 
 ## Adding and running examples
 

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 Public SDK
+   Copyright 2025 Channel3
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,9 +1,9 @@
-# Public SDK Python API library
+# Channel3 Python API library
 
 <!-- prettier-ignore -->
-[![PyPI version](https://img.shields.io/pypi/v/public_sdk.svg?label=pypi%20(stable))](https://pypi.org/project/public_sdk/)
+[![PyPI version](https://img.shields.io/pypi/v/channel3_sdk.svg?label=pypi%20(stable))](https://pypi.org/project/channel3_sdk/)
 
-The Public SDK Python library provides convenient access to the Public SDK REST API from any Python 3.8+
+The Channel3 Python library provides convenient access to the Channel3 REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
@@ -16,44 +16,45 @@ The full API of this library can be found in [api.md](api.md).
 ## Installation
 
 ```sh
-# install from the production repo
-pip install git+ssh://[email protected]/channel3-ai/sdk-python.git
+# install from PyPI
+pip install channel3_sdk
 ```
 
-> [!NOTE]
-> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install public_sdk`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 ```python
 import os
-from public_sdk import PublicSDK
+from channel3_sdk import Channel3
 
-client = PublicSDK(
-    api_key=os.environ.get("PUBLIC_SDK_API_KEY"),  # This is the default and can be omitted
+client = Channel3(
+    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
+    # defaults to "production".
+    environment="development",
 )
 
 response = client.search.perform()
 ```
 
 While you can provide an `api_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `PUBLIC_SDK_API_KEY="My API Key"` to your `.env` file
+to add `CHANNEL3_API_KEY="My API Key"` to your `.env` file
 so that your API Key is not stored in source control.
 
 ## Async usage
 
-Simply import `AsyncPublicSDK` instead of `PublicSDK` and use `await` with each API call:
+Simply import `AsyncChannel3` instead of `Channel3` and use `await` with each API call:
 
 ```python
 import os
 import asyncio
-from public_sdk import AsyncPublicSDK
+from channel3_sdk import AsyncChannel3
 
-client = AsyncPublicSDK(
-    api_key=os.environ.get("PUBLIC_SDK_API_KEY"),  # This is the default and can be omitted
+client = AsyncChannel3(
+    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
+    # defaults to "production".
+    environment="development",
 )
 
 
@@ -73,20 +74,20 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
 You can enable this by installing `aiohttp`:
 
 ```sh
-# install from the production repo
-pip install 'public_sdk[aiohttp] @ git+ssh://[email protected]/channel3-ai/sdk-python.git'
+# install from PyPI
+pip install channel3_sdk[aiohttp]
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
 
 ```python
 import asyncio
-from public_sdk import DefaultAioHttpClient
-from public_sdk import AsyncPublicSDK
+from channel3_sdk import DefaultAioHttpClient
+from channel3_sdk import AsyncChannel3
 
 
 async def main() -> None:
-    async with AsyncPublicSDK(
+    async with AsyncChannel3(
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
@@ -110,9 +111,9 @@ Typed requests and responses provide autocomplete and documentation within your
 Nested parameters are dictionaries, typed using `TypedDict`, for example:
 
 ```python
-from public_sdk import PublicSDK
+from channel3_sdk import Channel3
 
-client = PublicSDK()
+client = Channel3()
 
 response = client.search.perform(
     config={},
@@ -122,27 +123,27 @@ print(response.config)
 
 ## Handling errors
 
-When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `public_sdk.APIConnectionError` is raised.
+When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `channel3_sdk.APIConnectionError` is raised.
 
 When the API returns a non-success status code (that is, 4xx or 5xx
-response), a subclass of `public_sdk.APIStatusError` is raised, containing `status_code` and `response` properties.
+response), a subclass of `channel3_sdk.APIStatusError` is raised, containing `status_code` and `response` properties.
 
-All errors inherit from `public_sdk.APIError`.
+All errors inherit from `channel3_sdk.APIError`.
 
 ```python
-import public_sdk
-from public_sdk import PublicSDK
+import channel3_sdk
+from channel3_sdk import Channel3
 
-client = PublicSDK()
+client = Channel3()
 
 try:
     client.search.perform()
-except public_sdk.APIConnectionError as e:
+except channel3_sdk.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
-except public_sdk.RateLimitError as e:
+except channel3_sdk.RateLimitError as e:
     print("A 429 status code was received; we should back off a bit.")
-except public_sdk.APIStatusError as e:
+except channel3_sdk.APIStatusError as e:
     print("Another non-200-range status code was received")
     print(e.status_code)
     print(e.response)
@@ -170,10 +171,10 @@ Connection errors (for example, due to a network connectivity problem), 408 Requ
 You can use the `max_retries` option to configure or disable retry settings:
 
 ```python
-from public_sdk import PublicSDK
+from channel3_sdk import Channel3
 
 # Configure the default for all requests:
-client = PublicSDK(
+client = Channel3(
     # default is 2
     max_retries=0,
 )
@@ -188,16 +189,16 @@ By default requests time out after 1 minute. You can configure this with a `time
 which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
-from public_sdk import PublicSDK
+from channel3_sdk import Channel3
 
 # Configure the default for all requests:
-client = PublicSDK(
+client = Channel3(
     # 20 seconds (default is 1 minute)
     timeout=20.0,
 )
 
 # More granular control:
-client = PublicSDK(
+client = Channel3(
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
 )
 
@@ -215,10 +216,10 @@ Note that requests that time out are [retried twice by default](#retries).
 
 We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
 
-You can enable logging by setting the environment variable `PUBLIC_SDK_LOG` to `info`.
+You can enable logging by setting the environment variable `CHANNEL3_LOG` to `info`.
 
 ```shell
-$ export PUBLIC_SDK_LOG=info
+$ export CHANNEL3_LOG=info
 ```
 
 Or to `debug` for more verbose logging.
@@ -240,19 +241,19 @@ if response.my_field is None:
 The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
 
 ```py
-from public_sdk import PublicSDK
+from channel3_sdk import Channel3
 
-client = PublicSDK()
+client = Channel3()
 response = client.search.with_raw_response.perform()
 print(response.headers.get('X-My-Header'))
 
 search = response.parse()  # get the object that `search.perform()` would have returned
 print(search)
 ```
 
-These methods return an [`APIResponse`](https://github.com/channel3-ai/sdk-python/tree/main/src/public_sdk/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/channel3-ai/sdk-python/tree/main/src/channel3_sdk/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/channel3-ai/sdk-python/tree/main/src/public_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+The async client returns an [`AsyncAPIResponse`](https://github.com/channel3-ai/sdk-python/tree/main/src/channel3_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -314,10 +315,10 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 
 ```python
 import httpx
-from public_sdk import PublicSDK, DefaultHttpxClient
+from channel3_sdk import Channel3, DefaultHttpxClient
 
-client = PublicSDK(
-    # Or use the `PUBLIC_SDK_BASE_URL` env var
+client = Channel3(
+    # Or use the `CHANNEL3_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
     http_client=DefaultHttpxClient(
         proxy="http://my.test.proxy.example.com",
@@ -337,9 +338,9 @@ client.with_options(http_client=DefaultHttpxClient(...))
 By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
 
 ```py
-from public_sdk import PublicSDK
+from channel3_sdk import Channel3
 
-with PublicSDK() as client:
+with Channel3() as client:
   # make requests here
   ...
 
@@ -365,8 +366,8 @@ If you've upgraded to the latest version but aren't seeing any new features you
 You can determine the version that is being used at runtime with:
 
 ```py
-import public_sdk
-print(public_sdk.__version__)
+import channel3_sdk
+print(channel3_sdk.__version__)
 ```
 
 ## Requirements

SECURITY.md

@@ -16,7 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Public SDK, please follow the respective company's security reporting guidelines.
+or products provided by Channel3, please follow the respective company's security reporting guidelines.
+
+### Channel3 Terms and Policies
+
+Please contact [email protected] for any questions or concerns regarding the security of our services.
 
 ---
 

api.md

@@ -1,54 +1,54 @@
-# PublicSDK
+# Channel3
 
 Methods:
 
-- <code title="get /">client.<a href="./src/public_sdk/_client.py">retrieve</a>() -> object</code>
+- <code title="get /">client.<a href="./src/channel3_sdk/_client.py">retrieve</a>() -> object</code>
 
 # Search
 
 Types:
 
 ```python
-from public_sdk.types import SearchPerformResponse
+from channel3_sdk.types import SearchPerformResponse
 ```
 
 Methods:
 
-- <code title="post /v0/search">client.search.<a href="./src/public_sdk/resources/search.py">perform</a>(\*\*<a href="src/public_sdk/types/search_perform_params.py">params</a>) -> <a href="./src/public_sdk/types/search_perform_response.py">SearchPerformResponse</a></code>
+- <code title="post /v0/search">client.search.<a href="./src/channel3_sdk/resources/search.py">perform</a>(\*\*<a href="src/channel3_sdk/types/search_perform_params.py">params</a>) -> <a href="./src/channel3_sdk/types/search_perform_response.py">SearchPerformResponse</a></code>
 
 # Products
 
 Types:
 
 ```python
-from public_sdk.types import AvailabilityStatus, Price, Variant, ProductRetrieveResponse
+from channel3_sdk.types import AvailabilityStatus, Price, Variant, ProductRetrieveResponse
 ```
 
 Methods:
 
-- <code title="get /v0/products/{product_id}">client.products.<a href="./src/public_sdk/resources/products.py">retrieve</a>(product_id) -> <a href="./src/public_sdk/types/product_retrieve_response.py">ProductRetrieveResponse</a></code>
+- <code title="get /v0/products/{product_id}">client.products.<a href="./src/channel3_sdk/resources/products.py">retrieve</a>(product_id) -> <a href="./src/channel3_sdk/types/product_retrieve_response.py">ProductRetrieveResponse</a></code>
 
 # Brands
 
 Types:
 
 ```python
-from public_sdk.types import Brand, BrandListResponse
+from channel3_sdk.types import Brand, BrandListResponse
 ```
 
 Methods:
 
-- <code title="get /v0/brands/{brand_id}">client.brands.<a href="./src/public_sdk/resources/brands.py">retrieve</a>(brand_id) -> <a href="./src/public_sdk/types/brand.py">Brand</a></code>
-- <code title="get /v0/brands">client.brands.<a href="./src/public_sdk/resources/brands.py">list</a>(\*\*<a href="src/public_sdk/types/brand_list_params.py">params</a>) -> <a href="./src/public_sdk/types/brand_list_response.py">BrandListResponse</a></code>
+- <code title="get /v0/brands/{brand_id}">client.brands.<a href="./src/channel3_sdk/resources/brands.py">retrieve</a>(brand_id) -> <a href="./src/channel3_sdk/types/brand.py">Brand</a></code>
+- <code title="get /v0/brands">client.brands.<a href="./src/channel3_sdk/resources/brands.py">list</a>(\*\*<a href="src/channel3_sdk/types/brand_list_params.py">params</a>) -> <a href="./src/channel3_sdk/types/brand_list_response.py">BrandListResponse</a></code>
 
 # Enrich
 
 Types:
 
 ```python
-from public_sdk.types import EnrichEnrichURLResponse
+from channel3_sdk.types import EnrichEnrichURLResponse
 ```
 
 Methods:
 
-- <code title="post /v0/enrich">client.enrich.<a href="./src/public_sdk/resources/enrich.py">enrich_url</a>(\*\*<a href="src/public_sdk/types/enrich_enrich_url_params.py">params</a>) -> <a href="./src/public_sdk/types/enrich_enrich_url_response.py">EnrichEnrichURLResponse</a></code>
+- <code title="post /v0/enrich">client.enrich.<a href="./src/channel3_sdk/resources/enrich.py">enrich_url</a>(\*\*<a href="src/channel3_sdk/types/enrich_enrich_url_params.py">params</a>) -> <a href="./src/channel3_sdk/types/enrich_enrich_url_response.py">EnrichEnrichURLResponse</a></code>