release: 1.6.0 (#146)

* chore(docs): remove reference to rye shell

* chore(docs): remove unnecessary param examples

* feat(client): add follow_redirects request option

* chore(tests): run tests in parallel

* fix(client): correctly parse binary response | stream

* chore(tests): add tests for httpx client instantiation & proxies

* chore(internal): update conftest.py

* chore(ci): enable for pull requests

* feat(api): api update

* chore(readme): update badges

* fix(tests): fix: tests which call HTTP endpoints directly with the example parameters

* release: 1.6.0

---------

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

Author: stainless-app[bot]

.github/workflows/ci.yml

@@ -7,6 +7,10 @@ on:
       - 'integrated/**'
       - 'stl-preview-head/**'
       - 'stl-preview-base/**'
+  pull_request:
+    branches-ignore:
+      - 'stl-preview-head/**'
+      - 'stl-preview-base/**'
 
 jobs:
   lint:

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.5.0"
+  ".": "1.6.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 19
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/arcade-ai%2Farcade-engine-8c15fa101ceb4bf0f446fce918d2092361770e32ce43e6f88e1ece57244e8fa6.yml
-openapi_spec_hash: 008132037e04c877822a61f59c789647
-config_hash: 214997e49eded7cde9997ecb3bb24f68
+configured_endpoints: 28
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/arcade-ai%2Farcade-engine-51958c25f4f5f8d03d873744f15369a2ce2894f246f162aecac70d1b4d2b6008.yml
+openapi_spec_hash: 5f61d1691a2c83c8067bc837b0000237
+config_hash: 6eb072febff9e7aba9cdeb6901761b97

CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 1.6.0 (2025-06-18)
+
+Full Changelog: [v1.5.0...v1.6.0](https://github.com/ArcadeAI/arcade-py/compare/v1.5.0...v1.6.0)
+
+### Features
+
+* **api:** api update ([cd6f884](https://github.com/ArcadeAI/arcade-py/commit/cd6f884df03a517ad7af92d229f0178e181f52e7))
+* **client:** add follow_redirects request option ([37071b8](https://github.com/ArcadeAI/arcade-py/commit/37071b84834f987c5c97bd31e42598d29079e670))
+
+
+### Bug Fixes
+
+* **client:** correctly parse binary response | stream ([30b1399](https://github.com/ArcadeAI/arcade-py/commit/30b1399ae02f8190c79b330190f834291190f76c))
+* **tests:** fix: tests which call HTTP endpoints directly with the example parameters ([f7d916c](https://github.com/ArcadeAI/arcade-py/commit/f7d916c9c4927adc62b438b1b71eec3a242e8f3d))
+
+
+### Chores
+
+* **ci:** enable for pull requests ([181f08f](https://github.com/ArcadeAI/arcade-py/commit/181f08fa2a8bcef17a61dcefd0e4078b6f6357aa))
+* **docs:** remove reference to rye shell ([bb105b1](https://github.com/ArcadeAI/arcade-py/commit/bb105b130ee4f24fe8e4a8114b464ae9789ffcd8))
+* **docs:** remove unnecessary param examples ([e63f45b](https://github.com/ArcadeAI/arcade-py/commit/e63f45ba884856f91e7387ed73b87667557c8ef0))
+* **internal:** update conftest.py ([6f4b908](https://github.com/ArcadeAI/arcade-py/commit/6f4b908240825138aa4f97da939fd4b8cb965bad))
+* **readme:** update badges ([e0ecda6](https://github.com/ArcadeAI/arcade-py/commit/e0ecda6d97885630a77933dc7fdb57c2540c8a2d))
+* **tests:** add tests for httpx client instantiation & proxies ([8328a61](https://github.com/ArcadeAI/arcade-py/commit/8328a616e0f73562720bcdeee7532887ae328999))
+* **tests:** run tests in parallel ([aabdc37](https://github.com/ArcadeAI/arcade-py/commit/aabdc37b1979121dd756a6cc1dbe31145db3c9da))
+
 ## 1.5.0 (2025-06-02)
 
 Full Changelog: [v1.4.0...v1.5.0](https://github.com/ArcadeAI/arcade-py/compare/v1.4.0...v1.5.0)

CONTRIBUTING.md

@@ -17,8 +17,7 @@ $ rye sync --all-features
 You can then run scripts using `rye run python script.py` or by activating the virtual environment:
 
 ```sh
-$ rye shell
-# or manually activate - https://docs.python.org/3/library/venv.html#how-venvs-work
+# Activate the virtual environment - https://docs.python.org/3/library/venv.html#how-venvs-work
 $ source .venv/bin/activate
 
 # now you can omit the `rye run` prefix

README.md

@@ -1,6 +1,6 @@
 # Arcade Python API library
 
-[![PyPI version](https://img.shields.io/pypi/v/arcadepy.svg)](https://pypi.org/project/arcadepy/)
+[![PyPI version](<https://img.shields.io/pypi/v/arcadepy.svg?label=pypi%20(stable)>)](https://pypi.org/project/arcadepy/)
 
 The Arcade Python library provides convenient access to the Arcade REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -91,7 +91,7 @@ from arcadepy import Arcade
 client = Arcade()
 
 chat_response = client.chat.completions.create(
-    response_format={"type": "json_object"},
+    response_format={},
 )
 print(chat_response.response_format)
 ```

api.md

@@ -4,6 +4,55 @@
 from arcadepy.types import AuthorizationContext, AuthorizationResponse, Error
 ```
 
+# Admin
+
+## UserConnections
+
+Types:
+
+```python
+from arcadepy.types.admin import UserConnectionResponse
+```
+
+Methods:
+
+- <code title="get /v1/admin/user_connections">client.admin.user_connections.<a href="./src/arcadepy/resources/admin/user_connections.py">list</a>(\*\*<a href="src/arcadepy/types/admin/user_connection_list_params.py">params</a>) -> <a href="./src/arcadepy/types/admin/user_connection_response.py">SyncOffsetPage[UserConnectionResponse]</a></code>
+- <code title="delete /v1/admin/user_connections/{id}">client.admin.user_connections.<a href="./src/arcadepy/resources/admin/user_connections.py">delete</a>(id) -> None</code>
+
+## AuthProviders
+
+Types:
+
+```python
+from arcadepy.types.admin import (
+    AuthProviderCreateRequest,
+    AuthProviderResponse,
+    AuthProviderUpdateRequest,
+    AuthProviderListResponse,
+)
+```
+
+Methods:
+
+- <code title="post /v1/admin/auth_providers">client.admin.auth_providers.<a href="./src/arcadepy/resources/admin/auth_providers.py">create</a>(\*\*<a href="src/arcadepy/types/admin/auth_provider_create_params.py">params</a>) -> <a href="./src/arcadepy/types/admin/auth_provider_response.py">AuthProviderResponse</a></code>
+- <code title="get /v1/admin/auth_providers">client.admin.auth_providers.<a href="./src/arcadepy/resources/admin/auth_providers.py">list</a>() -> <a href="./src/arcadepy/types/admin/auth_provider_list_response.py">AuthProviderListResponse</a></code>
+- <code title="delete /v1/admin/auth_providers/{id}">client.admin.auth_providers.<a href="./src/arcadepy/resources/admin/auth_providers.py">delete</a>(id) -> <a href="./src/arcadepy/types/admin/auth_provider_response.py">AuthProviderResponse</a></code>
+- <code title="get /v1/admin/auth_providers/{id}">client.admin.auth_providers.<a href="./src/arcadepy/resources/admin/auth_providers.py">get</a>(id) -> <a href="./src/arcadepy/types/admin/auth_provider_response.py">AuthProviderResponse</a></code>
+- <code title="patch /v1/admin/auth_providers/{id}">client.admin.auth_providers.<a href="./src/arcadepy/resources/admin/auth_providers.py">patch</a>(path_id, \*\*<a href="src/arcadepy/types/admin/auth_provider_patch_params.py">params</a>) -> <a href="./src/arcadepy/types/admin/auth_provider_response.py">AuthProviderResponse</a></code>
+
+## Secrets
+
+Types:
+
+```python
+from arcadepy.types.admin import SecretResponse, SecretListResponse
+```
+
+Methods:
+
+- <code title="get /v1/admin/secrets">client.admin.secrets.<a href="./src/arcadepy/resources/admin/secrets.py">list</a>() -> <a href="./src/arcadepy/types/admin/secret_list_response.py">SecretListResponse</a></code>
+- <code title="delete /v1/admin/secrets/{secret_id}">client.admin.secrets.<a href="./src/arcadepy/resources/admin/secrets.py">delete</a>(secret_id) -> None</code>
+
 # Auth
 
 Types:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "arcadepy"
-version = "1.5.0"
+version = "1.6.0"
 description = "The official Python library for the Arcade API"
 dynamic = ["readme"]
 license = "MIT"
@@ -54,6 +54,7 @@ dev-dependencies = [
     "importlib-metadata>=6.7.0",
     "rich>=13.7.1",
     "nest_asyncio==1.6.0",
+    "pytest-xdist>=3.6.1",
 ]
 
 [tool.rye.scripts]
@@ -125,7 +126,7 @@ replacement = '[\1](https://github.com/ArcadeAI/arcade-py/tree/main/\g<2>)'
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
-addopts = "--tb=short"
+addopts = "--tb=short -n auto"
 xfail_strict = true
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "session"

requirements-dev.lock

@@ -30,6 +30,8 @@ distro==1.8.0
 exceptiongroup==1.2.2
     # via anyio
     # via pytest
+execnet==2.1.1
+    # via pytest-xdist
 filelock==3.12.4
     # via virtualenv
 h11==0.14.0
@@ -72,7 +74,9 @@ pygments==2.18.0
 pyright==1.1.399
 pytest==8.3.3
     # via pytest-asyncio
+    # via pytest-xdist
 pytest-asyncio==0.24.0
+pytest-xdist==3.7.0
 python-dateutil==2.8.2
     # via time-machine
 pytz==2023.3.post1

src/arcadepy/_base_client.py

@@ -960,6 +960,9 @@ def request(
             if self.custom_auth is not None:
                 kwargs["auth"] = self.custom_auth
 
+            if options.follow_redirects is not None:
+                kwargs["follow_redirects"] = options.follow_redirects
+
             log.debug("Sending HTTP Request: %s %s", request.method, request.url)
 
             response = None
@@ -1068,7 +1071,14 @@ def _process_response(
     ) -> ResponseT:
         origin = get_origin(cast_to) or cast_to
 
-        if inspect.isclass(origin) and issubclass(origin, BaseAPIResponse):
+        if (
+            inspect.isclass(origin)
+            and issubclass(origin, BaseAPIResponse)
+            # we only want to actually return the custom BaseAPIResponse class if we're
+            # returning the raw response, or if we're not streaming SSE, as if we're streaming
+            # SSE then `cast_to` doesn't actively reflect the type we need to parse into
+            and (not stream or bool(response.request.headers.get(RAW_RESPONSE_HEADER)))
+        ):
             if not issubclass(origin, APIResponse):
                 raise TypeError(f"API Response types must subclass {APIResponse}; Received {origin}")
 
@@ -1460,6 +1470,9 @@ async def request(
             if self.custom_auth is not None:
                 kwargs["auth"] = self.custom_auth
 
+            if options.follow_redirects is not None:
+                kwargs["follow_redirects"] = options.follow_redirects
+
             log.debug("Sending HTTP Request: %s %s", request.method, request.url)
 
             response = None
@@ -1568,7 +1581,14 @@ async def _process_response(
     ) -> ResponseT:
         origin = get_origin(cast_to) or cast_to
 
-        if inspect.isclass(origin) and issubclass(origin, BaseAPIResponse):
+        if (
+            inspect.isclass(origin)
+            and issubclass(origin, BaseAPIResponse)
+            # we only want to actually return the custom BaseAPIResponse class if we're
+            # returning the raw response, or if we're not streaming SSE, as if we're streaming
+            # SSE then `cast_to` doesn't actively reflect the type we need to parse into
+            and (not stream or bool(response.request.headers.get(RAW_RESPONSE_HEADER)))
+        ):
             if not issubclass(origin, AsyncAPIResponse):
                 raise TypeError(f"API Response types must subclass {AsyncAPIResponse}; Received {origin}")