release: 0.14.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.13.0"
+  ".": "0.14.0"
 }

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.14.0 (2024-01-16)
+
+Full Changelog: [v0.13.0...v0.14.0](https://github.com/Dataherald/dataherald-python/compare/v0.13.0...v0.14.0)
+
+### Features
+
+* **api:** OpenAPI spec update ([#28](https://github.com/Dataherald/dataherald-python/issues/28)) ([7bf083e](https://github.com/Dataherald/dataherald-python/commit/7bf083e324b5df82263c1a3f7818581312b3beb0))
+
 ## 0.13.0 (2024-01-12)
 
 Full Changelog: [v0.12.0...v0.13.0](https://github.com/Dataherald/dataherald-python/compare/v0.12.0...v0.13.0)

README.md

@@ -191,7 +191,7 @@ if response.my_field is None:
 
 ### Accessing raw response data (e.g. headers)
 
-The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call.
+The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
 
 ```py
 from dataherald import Dataherald
@@ -206,6 +206,24 @@ print(database_connection.id)
 
 These methods return an [`APIResponse`](https://github.com/Dataherald/dataherald-python/tree/main/src/dataherald/_response.py) object.
 
+The async client returns an [`AsyncAPIResponse`](https://github.com/Dataherald/dataherald-python/tree/main/src/dataherald/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+
+#### `.with_streaming_response`
+
+The above interface eagerly reads the full response body when you make the request, which may not always be what you want.
+
+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.database_connections.with_streaming_response.create() as response:
+    print(response.headers.get("X-My-Header"))
+
+    for line in response.iter_lines():
+        print(line)
+```
+
+The context manager is required so that the response will reliably be closed.
+
 ### Configuring the HTTP client
 
 You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dataherald"
-version = "0.13.0"
+version = "0.14.0"
 description = "The official Python library for the Dataherald API"
 readme = "README.md"
 license = "Apache-2.0"

src/dataherald/__init__.py

@@ -16,6 +16,7 @@
     AsyncDataherald,
 )
 from ._version import __title__, __version__
+from ._response import APIResponse as APIResponse, AsyncAPIResponse as AsyncAPIResponse
 from ._exceptions import (
     APIError,
     ConflictError,