release: 1.8.0 (#51)

* feat(api): api update

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

* chore(internal): update conftest.py

* chore(ci): enable for pull requests

* chore(readme): update badges

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

* docs(client): fix httpx.Timeout documentation reference

* feat(client): add support for aiohttp

* release: 1.8.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.7.1"
+  ".": "1.8.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 89
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-ba629bb393f43737dec9702d5610ac4b5696e58f58177d1d98f4f832c9553b76.yml
-openapi_spec_hash: abeac01a8a235ea114e466d4f06e70ad
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-c15e6924891ae19a301d5e878d353bda7cf6aa486c13be9525fe9d4d06eb140f.yml
+openapi_spec_hash: 397a88d71e81d4339d41c151a61e12b9
 config_hash: b4c547c1d4c8cd0834bc793ddf5388ee

CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## 1.8.0 (2025-06-21)
+
+Full Changelog: [v1.7.1...v1.8.0](https://github.com/knocklabs/knock-python/compare/v1.7.1...v1.8.0)
+
+### Features
+
+* **api:** api update ([4f1b799](https://github.com/knocklabs/knock-python/commit/4f1b799dcdf50253c531f5c1c9b71c6feec3cd98))
+* **client:** add support for aiohttp ([43bd2be](https://github.com/knocklabs/knock-python/commit/43bd2beae3e2e969ab3af11b3a40b0e3ce58a9c1))
+
+
+### Bug Fixes
+
+* **tests:** fix: tests which call HTTP endpoints directly with the example parameters ([beb242d](https://github.com/knocklabs/knock-python/commit/beb242d5a2280d777875f6b2481f2647ae9656b1))
+
+
+### Chores
+
+* **ci:** enable for pull requests ([38cb0ce](https://github.com/knocklabs/knock-python/commit/38cb0ce8e86ff6fe1c676805bfb708ab37ed4319))
+* **internal:** update conftest.py ([5bcbc15](https://github.com/knocklabs/knock-python/commit/5bcbc15a618a92a5b4bbf73c612583566d78989d))
+* **readme:** update badges ([b72984d](https://github.com/knocklabs/knock-python/commit/b72984d6cf99fbb5d78e5af92e6ef82cae007a31))
+* **tests:** add tests for httpx client instantiation & proxies ([e971449](https://github.com/knocklabs/knock-python/commit/e9714490d78f9f477437425a72451c1a5a74b16c))
+
+
+### Documentation
+
+* **client:** fix httpx.Timeout documentation reference ([7239e56](https://github.com/knocklabs/knock-python/commit/7239e56653b2b96dda92053ef69c1e944e9e8980))
+
 ## 1.7.1 (2025-06-13)
 
 Full Changelog: [v1.7.0...v1.7.1](https://github.com/knocklabs/knock-python/compare/v1.7.0...v1.7.1)

README.md

@@ -1,6 +1,6 @@
 # Knock Python API library
 
-[![PyPI version](https://img.shields.io/pypi/v/knockapi.svg)](https://pypi.org/project/knockapi/)
+[![PyPI version](<https://img.shields.io/pypi/v/knockapi.svg?label=pypi%20(stable)>)](https://pypi.org/project/knockapi/)
 
 The Knock Python library provides convenient access to the Knock REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -72,6 +72,42 @@ asyncio.run(main())
 
 Functionality between the synchronous and asynchronous clients is otherwise identical.
 
+### With aiohttp
+
+By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
+
+You can enable this by installing `aiohttp`:
+
+```sh
+# install from PyPI
+pip install knockapi[aiohttp]
+```
+
+Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
+
+```python
+import os
+import asyncio
+from knockapi import DefaultAioHttpClient
+from knockapi import AsyncKnock
+
+
+async def main() -> None:
+    async with AsyncKnock(
+        api_key=os.environ.get("KNOCK_API_KEY"),  # This is the default and can be omitted
+        http_client=DefaultAioHttpClient(),
+    ) as client:
+        response = await client.workflows.trigger(
+            key="dinosaurs-loose",
+            recipients=["dnedry"],
+            data={"dinosaur": "triceratops"},
+        )
+        print(response.workflow_run_id)
+
+
+asyncio.run(main())
+```
+
 ## Using types
 
 Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
@@ -229,7 +265,7 @@ client.with_options(max_retries=5).users.get(
 ### Timeouts
 
 By default requests time out after 1 minute. You can configure this with a `timeout` option,
-which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
 from knockapi import Knock

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "knockapi"
-version = "1.7.1"
+version = "1.8.0"
 description = "The official Python library for the knock API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -37,6 +37,8 @@ classifiers = [
 Homepage = "https://github.com/knocklabs/knock-python"
 Repository = "https://github.com/knocklabs/knock-python"
 
+[project.optional-dependencies]
+aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.6"]
 
 [tool.rye]
 managed = true

requirements-dev.lock

@@ -10,13 +10,24 @@
 #   universal: false
 
 -e file:.
+aiohappyeyeballs==2.6.1
+    # via aiohttp
+aiohttp==3.12.8
+    # via httpx-aiohttp
+    # via knockapi
+aiosignal==1.3.2
+    # via aiohttp
 annotated-types==0.6.0
     # via pydantic
 anyio==4.4.0
     # via httpx
     # via knockapi
 argcomplete==3.1.2
     # via nox
+async-timeout==5.0.1
+    # via aiohttp
+attrs==25.3.0
+    # via aiohttp
 certifi==2023.7.22
     # via httpcore
     # via httpx
@@ -34,23 +45,33 @@ execnet==2.1.1
     # via pytest-xdist
 filelock==3.12.4
     # via virtualenv
+frozenlist==1.6.2
+    # via aiohttp
+    # via aiosignal
 h11==0.14.0
     # via httpcore
 httpcore==1.0.2
     # via httpx
 httpx==0.28.1
+    # via httpx-aiohttp
     # via knockapi
     # via respx
+httpx-aiohttp==0.1.6
+    # via knockapi
 idna==3.4
     # via anyio
     # via httpx
+    # via yarl
 importlib-metadata==7.0.0
 iniconfig==2.0.0
     # via pytest
 markdown-it-py==3.0.0
     # via rich
 mdurl==0.1.2
     # via markdown-it-py
+multidict==6.4.4
+    # via aiohttp
+    # via yarl
 mypy==1.14.1
 mypy-extensions==1.0.0
     # via mypy
@@ -65,6 +86,9 @@ platformdirs==3.11.0
     # via virtualenv
 pluggy==1.5.0
     # via pytest
+propcache==0.3.1
+    # via aiohttp
+    # via yarl
 pydantic==2.10.3
     # via knockapi
 pydantic-core==2.27.1
@@ -98,11 +122,14 @@ tomli==2.0.2
 typing-extensions==4.12.2
     # via anyio
     # via knockapi
+    # via multidict
     # via mypy
     # via pydantic
     # via pydantic-core
     # via pyright
 virtualenv==20.24.5
     # via nox
+yarl==1.20.0
+    # via aiohttp
 zipp==3.17.0
     # via importlib-metadata

requirements.lock

@@ -10,27 +10,51 @@
 #   universal: false
 
 -e file:.
+aiohappyeyeballs==2.6.1
+    # via aiohttp
+aiohttp==3.12.8
+    # via httpx-aiohttp
+    # via knockapi
+aiosignal==1.3.2
+    # via aiohttp
 annotated-types==0.6.0
     # via pydantic
 anyio==4.4.0
     # via httpx
     # via knockapi
+async-timeout==5.0.1
+    # via aiohttp
+attrs==25.3.0
+    # via aiohttp
 certifi==2023.7.22
     # via httpcore
     # via httpx
 distro==1.8.0
     # via knockapi
 exceptiongroup==1.2.2
     # via anyio
+frozenlist==1.6.2
+    # via aiohttp
+    # via aiosignal
 h11==0.14.0
     # via httpcore
 httpcore==1.0.2
     # via httpx
 httpx==0.28.1
+    # via httpx-aiohttp
+    # via knockapi
+httpx-aiohttp==0.1.6
     # via knockapi
 idna==3.4
     # via anyio
     # via httpx
+    # via yarl
+multidict==6.4.4
+    # via aiohttp
+    # via yarl
+propcache==0.3.1
+    # via aiohttp
+    # via yarl
 pydantic==2.10.3
     # via knockapi
 pydantic-core==2.27.1
@@ -41,5 +65,8 @@ sniffio==1.3.0
 typing-extensions==4.12.2
     # via anyio
     # via knockapi
+    # via multidict
     # via pydantic
     # via pydantic-core
+yarl==1.20.0
+    # via aiohttp

src/knockapi/__init__.py

@@ -26,7 +26,7 @@
     UnprocessableEntityError,
     APIResponseValidationError,
 )
-from ._base_client import DefaultHttpxClient, DefaultAsyncHttpxClient
+from ._base_client import DefaultHttpxClient, DefaultAioHttpClient, DefaultAsyncHttpxClient
 from ._utils._logs import setup_logging as _setup_logging
 
 __all__ = [
@@ -68,6 +68,7 @@
     "DEFAULT_CONNECTION_LIMITS",
     "DefaultHttpxClient",
     "DefaultAsyncHttpxClient",
+    "DefaultAioHttpClient",
 ]
 
 if not _t.TYPE_CHECKING:

src/knockapi/_base_client.py

@@ -1289,6 +1289,24 @@ def __init__(self, **kwargs: Any) -> None:
         super().__init__(**kwargs)
 
 
+try:
+    import httpx_aiohttp
+except ImportError:
+
+    class _DefaultAioHttpClient(httpx.AsyncClient):
+        def __init__(self, **_kwargs: Any) -> None:
+            raise RuntimeError("To use the aiohttp client you must have installed the package with the `aiohttp` extra")
+else:
+
+    class _DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: Any) -> None:
+            kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
+            kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
+            kwargs.setdefault("follow_redirects", True)
+
+            super().__init__(**kwargs)
+
+
 if TYPE_CHECKING:
     DefaultAsyncHttpxClient = httpx.AsyncClient
     """An alias to `httpx.AsyncClient` that provides the same defaults that this SDK
@@ -1297,8 +1315,12 @@ def __init__(self, **kwargs: Any) -> None:
     This is useful because overriding the `http_client` with your own instance of
     `httpx.AsyncClient` will result in httpx's defaults being used, not ours.
     """
+
+    DefaultAioHttpClient = httpx.AsyncClient
+    """An alias to `httpx.AsyncClient` that changes the default HTTP transport to `aiohttp`."""
 else:
     DefaultAsyncHttpxClient = _DefaultAsyncHttpxClient
+    DefaultAioHttpClient = _DefaultAioHttpClient
 
 
 class AsyncHttpxClientWrapper(DefaultAsyncHttpxClient):