release: 0.1.0-alpha.1 (#13)

Co-authored-by: Lingxi @ Contextual <lingxi@contextual.ai>
Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.github/workflows/publish-pypi.yml

@@ -0,0 +1,31 @@
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to PyPI in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/ContextualAI/contextual-client-python/actions/workflows/publish-pypi.yml
+name: Publish PyPI
+on:
+  workflow_dispatch:
+
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rye
+        run: |
+          curl -sSf https://rye.astral.sh/get | bash
+          echo "$HOME/.rye/shims" >> $GITHUB_PATH
+        env:
+          RYE_VERSION: '0.35.0'
+          RYE_INSTALL_OPTION: '--yes'
+
+      - name: Publish to PyPI
+        run: |
+          bash ./bin/publish-pypi
+        env:
+          PYPI_TOKEN: ${{ secrets.CONTEXTUAL_AI_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.github/workflows/release-doctor.yml

@@ -0,0 +1,21 @@
+name: Release Doctor
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  release_doctor:
+    name: release doctor
+    runs-on: ubuntu-latest
+    if: github.repository == 'ContextualAI/contextual-client-python' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check release environment
+        run: |
+          bash ./bin/check-release-environment
+        env:
+          PYPI_TOKEN: ${{ secrets.CONTEXTUAL_AI_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0-alpha.1"
+}

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 32
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/contextual-ai%2Fsunrise-cd093ffe774597dbf8ec7b8b98cf60dda877d59af9b2d42826c80e8b1a92f904.yml
+configured_endpoints: 39
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/contextual-ai%2Fsunrise-478f305e228bf07625e8d1166c8a8d2a38c532d27012ce7ed906d0a3728f26f9.yml

CHANGELOG.md

@@ -0,0 +1,64 @@
+# Changelog
+
+## 0.1.0-alpha.1 (2025-01-15)
+
+Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/ContextualAI/contextual-client-python/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
+
+### Features
+
+* **api:** update via SDK Studio ([b26af54](https://github.com/ContextualAI/contextual-client-python/commit/b26af545d014d2ebbb0b95786325776a76cf4c37))
+* **api:** update via SDK Studio ([993c748](https://github.com/ContextualAI/contextual-client-python/commit/993c74879dc993e1c28f044fd7246bbd09d79a66))
+* **api:** update via SDK Studio ([ed4eda6](https://github.com/ContextualAI/contextual-client-python/commit/ed4eda61c3aa6535e6252a69c3a324d5ae996ef7))
+* **api:** update via SDK Studio ([89997a9](https://github.com/ContextualAI/contextual-client-python/commit/89997a98ea2019a768dde3d93f101871311185e0))
+* **api:** update via SDK Studio ([c4f9a7a](https://github.com/ContextualAI/contextual-client-python/commit/c4f9a7ad111def98c39764d1c4af7c37f4704912))
+* **api:** update via SDK Studio ([8ee9b9b](https://github.com/ContextualAI/contextual-client-python/commit/8ee9b9b7fa9ecb74097893b59b670675c399489d))
+* **api:** update via SDK Studio ([a116bc0](https://github.com/ContextualAI/contextual-client-python/commit/a116bc03080ff09e0269c995c8e67dc49a8c563f))
+* **api:** update via SDK Studio ([ef744ef](https://github.com/ContextualAI/contextual-client-python/commit/ef744ef0f11559c6df063fd68268be0ed646606b))
+* **api:** update via SDK Studio ([04d45a7](https://github.com/ContextualAI/contextual-client-python/commit/04d45a7d0d6dddd8b826592146e696264975db37))
+* **api:** update via SDK Studio ([5e4dab5](https://github.com/ContextualAI/contextual-client-python/commit/5e4dab55c8763098e750fe58f8501b1e21b08d11))
+* **api:** update via SDK Studio ([18443a5](https://github.com/ContextualAI/contextual-client-python/commit/18443a52b8fe05eba8098295cd39f99d36de2d0e))
+* **api:** update via SDK Studio ([17ba526](https://github.com/ContextualAI/contextual-client-python/commit/17ba5269a45738e5d7e0a833b887f32465266531))
+* **api:** update via SDK Studio ([581ec7e](https://github.com/ContextualAI/contextual-client-python/commit/581ec7e0f55ad14aa72de15bae22d298b25df17d))
+* **api:** update via SDK Studio ([9862571](https://github.com/ContextualAI/contextual-client-python/commit/986257157c57188953637bd4b43150a0492babcc))
+* **api:** update via SDK Studio ([dedbd4a](https://github.com/ContextualAI/contextual-client-python/commit/dedbd4ad104e03310190ad0776ba959758365c87))
+* **api:** update via SDK Studio ([a8bd7a6](https://github.com/ContextualAI/contextual-client-python/commit/a8bd7a6c3b40f03c6732fc5984dd82dd762a371b))
+* **api:** update via SDK Studio ([eb46df2](https://github.com/ContextualAI/contextual-client-python/commit/eb46df2656bb40a05d5443f148529b2945cba2e6))
+* **api:** update via SDK Studio ([d72e3cf](https://github.com/ContextualAI/contextual-client-python/commit/d72e3cfee20d002616d1f17412e919495b051e79))
+* **api:** update via SDK Studio ([3d1cde0](https://github.com/ContextualAI/contextual-client-python/commit/3d1cde029bf1c7de64d82a18ce4a87097c0065c0))
+* **api:** update via SDK Studio ([6cb72bf](https://github.com/ContextualAI/contextual-client-python/commit/6cb72bf6f0b8e4f14c15e4a8c6eac91dffce3358))
+* **api:** update via SDK Studio ([73639c4](https://github.com/ContextualAI/contextual-client-python/commit/73639c4a11978159b2a1fbf7b5d849a6358852dc))
+* **api:** update via SDK Studio ([3c4ff11](https://github.com/ContextualAI/contextual-client-python/commit/3c4ff11698404e2e391a8194b58a147b5b2a373a))
+* use customized prism-cli from npm. ([86d8b36](https://github.com/ContextualAI/contextual-client-python/commit/86d8b36c7d99031057b5d16ad77d0fa3f54b0861))
+
+
+### Bug Fixes
+
+* **client:** only call .close() when needed ([e9f24af](https://github.com/ContextualAI/contextual-client-python/commit/e9f24af4d134d7919fde20dde45c928e8dc14680))
+* correctly handle deserialising `cls` fields ([9b002bf](https://github.com/ContextualAI/contextual-client-python/commit/9b002bf0ec2bc6ea8fd79bef8eafddfa07f1fe3a))
+
+
+### Chores
+
+* add missing isclass check ([d373c16](https://github.com/ContextualAI/contextual-client-python/commit/d373c16e7e1d6964e603511a344c538afbd1b5c4))
+* add universal flag to lock files. ([c745c46](https://github.com/ContextualAI/contextual-client-python/commit/c745c46eb528a52fc3c174ce91ca93177db533f8))
+* code cleanup. ([b2d17e0](https://github.com/ContextualAI/contextual-client-python/commit/b2d17e02b6a0631da4bd067a7bba24f23871fa9f))
+* ignore `.DS_Store`. ([4d88206](https://github.com/ContextualAI/contextual-client-python/commit/4d882066acf442591667f2b7bdc2412abff4a504))
+* **internal:** add support for TypeAliasType ([8954c97](https://github.com/ContextualAI/contextual-client-python/commit/8954c972f145f840a75fda49e0fd842d2dcce024))
+* **internal:** bump httpx dependency ([a1caab0](https://github.com/ContextualAI/contextual-client-python/commit/a1caab00b5bad0092c0d762395f5ddbf534957ea))
+* **internal:** bump pydantic dependency ([f7caf20](https://github.com/ContextualAI/contextual-client-python/commit/f7caf20d9ce678e26a23f926e87d67b740f1a8f7))
+* **internal:** bump pyright ([e78ad59](https://github.com/ContextualAI/contextual-client-python/commit/e78ad59a3d6cb212d3ff41d03469745c2fcaa3ad))
+* **internal:** codegen related update ([6208f37](https://github.com/ContextualAI/contextual-client-python/commit/6208f37ebeda115283e07d7b497291bb105ae822))
+* **internal:** codegen related update ([2c55602](https://github.com/ContextualAI/contextual-client-python/commit/2c556026684cc39ea763c67a26f3860529246f88))
+* **internal:** codegen related update ([c90698a](https://github.com/ContextualAI/contextual-client-python/commit/c90698a2e6c51f1524c6f34cf599164309141eec))
+* **internal:** codegen related update ([215c573](https://github.com/ContextualAI/contextual-client-python/commit/215c573ac64e31481c41f2635e908197b32da724))
+* **internal:** codegen related update ([e943905](https://github.com/ContextualAI/contextual-client-python/commit/e9439056db5b3753011ecd1a2c944588e8405fbd))
+* **internal:** fix some typos ([beafdbd](https://github.com/ContextualAI/contextual-client-python/commit/beafdbdd47fd466c76130dc1f72e7829edd76f39))
+* remove custom code ([6ad0c2c](https://github.com/ContextualAI/contextual-client-python/commit/6ad0c2c8cbc8cbfa00fd961ac7053ce7232ed8df))
+* update README. ([6b324de](https://github.com/ContextualAI/contextual-client-python/commit/6b324de7f2818bd3b6aa1d9e20ab47d3d74e25ea))
+
+
+### Documentation
+
+* fix typos ([ff04307](https://github.com/ContextualAI/contextual-client-python/commit/ff04307fb89c7da8ef313ee19e20ed19cad01f0c))
+* **readme:** example snippet for client context manager ([fd9d286](https://github.com/ContextualAI/contextual-client-python/commit/fd9d2869b622ea1633b4ffd013d0ce2d090d03c8))
+* **readme:** fix http client proxies example ([cca1f66](https://github.com/ContextualAI/contextual-client-python/commit/cca1f6666835843fbb560124667371f938d4e499))

CONTRIBUTING.md

@@ -63,7 +63,7 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```sh
-$ pip install git+ssh://git@github.com/stainless-sdks/sunrise-python.git
+$ pip install git+ssh://git@github.com/ContextualAI/contextual-client-python.git
 ```
 
 Alternatively, you can build from source and install the wheel file:
@@ -121,7 +121,7 @@ the changes aren't made through the automated pipeline, you may want to make rel
 
 ### Publish with a GitHub workflow
 
-You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/stainless-sdks/sunrise-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
+You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/ContextualAI/contextual-client-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
 
 ### Publish manually
 

README.md

@@ -13,13 +13,10 @@ The REST API documentation can be found on [docs.contextual.ai](https://docs.con
 ## Installation
 
 ```sh
-# install from this staging repo
-pip install git+ssh://git@github.com/stainless-sdks/sunrise-python.git
+# install from PyPI
+pip install --pre contextual-client
 ```
 
-> [!NOTE]
-> Once this package is [published to PyPI](https://app.stainlessapi.com/docs/guides/publish), this will become: `pip install --pre contextual-client`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
@@ -32,10 +29,10 @@ client = ContextualAI(
     api_key=os.environ.get("CONTEXTUAL_API_KEY"),  # This is the default and can be omitted
 )
 
-create_application_output = client.applications.create(
+create_agent_output = client.agents.create(
     name="xxx",
 )
-print(create_application_output.application_id)
+print(create_agent_output.id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -58,10 +55,10 @@ client = AsyncContextualAI(
 
 
 async def main() -> None:
-    create_application_output = await client.applications.create(
+    create_agent_output = await client.agents.create(
         name="xxx",
     )
-    print(create_application_output.application_id)
+    print(create_agent_output.id)
 
 
 asyncio.run(main())
@@ -89,12 +86,12 @@ from contextual import ContextualAI
 
 client = ContextualAI()
 
-all_applications = []
+all_agents = []
 # Automatically fetches more pages as needed.
-for application in client.applications.list():
-    # Do something with application here
-    all_applications.append(application)
-print(all_applications)
+for agent in client.agents.list():
+    # Do something with agent here
+    all_agents.append(agent)
+print(all_agents)
 ```
 
 Or, asynchronously:
@@ -107,11 +104,11 @@ client = AsyncContextualAI()
 
 
 async def main() -> None:
-    all_applications = []
+    all_agents = []
     # Iterate through items across all pages, issuing requests as needed.
-    async for application in client.applications.list():
-        all_applications.append(application)
-    print(all_applications)
+    async for agent in client.agents.list():
+        all_agents.append(agent)
+    print(all_agents)
 
 
 asyncio.run(main())
@@ -120,23 +117,23 @@ asyncio.run(main())
 Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
 
 ```python
-first_page = await client.applications.list()
+first_page = await client.agents.list()
 if first_page.has_next_page():
     print(f"will fetch next page using these details: {first_page.next_page_info()}")
     next_page = await first_page.get_next_page()
-    print(f"number of items we just fetched: {len(next_page.applications)}")
+    print(f"number of items we just fetched: {len(next_page.data)}")
 
 # Remove `await` for non-async usage.
 ```
 
 Or just work directly with the returned data:
 
 ```python
-first_page = await client.applications.list()
+first_page = await client.agents.list()
 
 print(f"next page cursor: {first_page.next_cursor}")  # => "next page cursor: ..."
-for application in first_page.applications:
-    print(application.id)
+for agent in first_page.data:
+    print(agent.id)
 
 # Remove `await` for non-async usage.
 ```
@@ -157,7 +154,7 @@ from contextual import ContextualAI
 client = ContextualAI()
 
 try:
-    client.applications.create(
+    client.agents.create(
         name="xxx",
     )
 except contextual.APIConnectionError as e:
@@ -202,7 +199,7 @@ client = ContextualAI(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).applications.create(
+client.with_options(max_retries=5).agents.create(
     name="xxx",
 )
 ```
@@ -227,7 +224,7 @@ client = ContextualAI(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).applications.create(
+client.with_options(timeout=5.0).agents.create(
     name="xxx",
 )
 ```
@@ -270,18 +267,18 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from contextual import ContextualAI
 
 client = ContextualAI()
-response = client.applications.with_raw_response.create(
+response = client.agents.with_raw_response.create(
     name="xxx",
 )
 print(response.headers.get('X-My-Header'))
 
-application = response.parse()  # get the object that `applications.create()` would have returned
-print(application.application_id)
+agent = response.parse()  # get the object that `agents.create()` would have returned
+print(agent.id)
 ```
 
-These methods return an [`APIResponse`](https://github.com/stainless-sdks/sunrise-python/tree/main/src/contextual/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/ContextualAI/contextual-client-python/tree/main/src/contextual/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/sunrise-python/tree/main/src/contextual/_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/ContextualAI/contextual-client-python/tree/main/src/contextual/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -290,7 +287,7 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.applications.with_streaming_response.create(
+with client.agents.with_streaming_response.create(
     name="xxx",
 ) as response:
     print(response.headers.get("X-My-Header"))
@@ -387,7 +384,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con
 
 We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
 
-We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/sunrise-python/issues) with questions, bugs, or suggestions.
+We are keen for your feedback; please open an [issue](https://www.github.com/ContextualAI/contextual-client-python/issues) with questions, bugs, or suggestions.
 
 ### Determining the installed version