Merge pull request #53 from Dataherald/release-please--branches--main…

…--changes--next

release: 0.20.0

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
           echo "$HOME/.rye/shims" >> $GITHUB_PATH
         env:
           RYE_VERSION: 0.24.0
-          RYE_INSTALL_OPTION: "--yes"
+          RYE_INSTALL_OPTION: '--yes'
 
       - name: Install dependencies
         run: |
@@ -39,3 +39,24 @@ jobs:
       - name: Ensure importable
         run: |
           rye run python -c 'import dataherald'
+  test:
+    name: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rye
+        run: |
+          curl -sSf https://rye-up.com/get | bash
+          echo "$HOME/.rye/shims" >> $GITHUB_PATH
+        env:
+          RYE_VERSION: 0.24.0
+          RYE_INSTALL_OPTION: '--yes'
+
+      - name: Bootstrap
+        run: ./scripts/bootstrap
+
+      - name: Run tests
+        run: ./scripts/test
+

.github/workflows/publish-pypi.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Install Rye
         run: |

.github/workflows/release-doctor.yml

@@ -10,7 +10,7 @@ jobs:
     if: github.repository == 'Dataherald/dataherald-python' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Check release environment
         run: |

.gitignore

@@ -12,3 +12,4 @@ dist
 .env
 .envrc
 codegen.log
+Brewfile.lock.json

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.19.0"
+  ".": "0.20.0"
 }

.stats.yml

@@ -1 +1,2 @@
 configured_endpoints: 46
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/Dataherald%2FDataherald-e168e98625a857aa05a5619a5dfd3cc3007a45d78630dfd9fbfdc6c700ce7f11.yml

Brewfile

@@ -0,0 +1,2 @@
+brew "rye"
+

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.20.0 (2024-05-06)
+
+Full Changelog: [v0.19.0...v0.20.0](https://github.com/Dataherald/dataherald-python/compare/v0.19.0...v0.20.0)
+
+### Features
+
+* **api:** update via SDK Studio ([#52](https://github.com/Dataherald/dataherald-python/issues/52)) ([84b46e9](https://github.com/Dataherald/dataherald-python/commit/84b46e9a1aa8046a1b8c909669c746f95ef6c567))
+
 ## 0.19.0 (2024-02-28)
 
 Full Changelog: [v0.18.0...v0.19.0](https://github.com/Dataherald/dataherald-python/compare/v0.18.0...v0.19.0)

CONTRIBUTING.md

@@ -59,7 +59,7 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```bash
-pip install git+ssh://[email protected]:Dataherald/dataherald-python.git
+pip install git+ssh://[email protected]/Dataherald/dataherald-python.git
 ```
 
 Alternatively, you can build from source and install the wheel file:
@@ -82,11 +82,11 @@ pip install ./path-to-wheel-file.whl
 
 ## Running tests
 
-Most tests will require you to [setup a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
+Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
 
 ```bash
 # you will need npm installed
-npx prism path/to/your/openapi.yml
+npx prism mock path/to/your/openapi.yml
 ```
 
 ```bash
@@ -117,9 +117,9 @@ 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/Dataherald/dataherald-python/actions/workflows/publish-pypi.yml). This will require 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/Dataherald/dataherald-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
 
 ### Publish manually
 
-If you need to manually release a package, you can run the `bin/publish-pypi` script with an `PYPI_TOKEN` set on
+If you need to manually release a package, you can run the `bin/publish-pypi` script with a `PYPI_TOKEN` set on
 the environment.

README.md

@@ -6,13 +6,16 @@ The Dataherald Python library provides convenient access to the Dataherald REST
 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).
 
+It is generated with [Stainless](https://www.stainlessapi.com/).
+
 ## Documentation
 
 The REST API documentation can be found [on dataherald.readthedocs.io](https://dataherald.readthedocs.io/en/latest/). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
 ```sh
+# install from PyPI
 pip install dataherald
 ```
 
@@ -21,12 +24,9 @@ pip install dataherald
 The full API of this library can be found in [api.md](api.md).
 
 ```python
-import os
 from dataherald import Dataherald
 
 client = Dataherald(
-    # This is the default and can be omitted
-    api_key=os.environ.get("DATAHERALD_API_KEY"),
     # defaults to "production".
     environment="staging",
 )
@@ -48,13 +48,10 @@ so that your API Key is not stored in source control.
 Simply import `AsyncDataherald` instead of `Dataherald` and use `await` with each API call:
 
 ```python
-import os
 import asyncio
 from dataherald import AsyncDataherald
 
 client = AsyncDataherald(
-    # This is the default and can be omitted
-    api_key=os.environ.get("DATAHERALD_API_KEY"),
     # defaults to "production".
     environment="staging",
 )
@@ -75,10 +72,10 @@ Functionality between the synchronous and asynchronous clients is otherwise iden
 
 ## 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 provide helper methods for things like:
+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:
 
-- Serializing back into JSON, `model.model_dump_json(indent=2, exclude_unset=True)`
-- Converting to a dictionary, `model.model_dump(exclude_unset=True)`
+- Serializing back into JSON, `model.to_json()`
+- Converting to a dictionary, `model.to_dict()`
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
@@ -128,7 +125,7 @@ Error codes are as followed:
 
 ### Retries
 
-Certain errors are automatically retried 0 times by default, with a short exponential backoff.
+Certain errors are automatically retried 2 times by default, with a short exponential backoff.
 Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
 429 Rate Limit, and >=500 Internal errors are all retried by default.
 
@@ -170,7 +167,7 @@ client = Dataherald(
 )
 
 # Override per-request:
-client.with_options(timeout=5 * 1000).database_connections.create(
+client.with_options(timeout=5.0).database_connections.create(
     alias="string",
     connection_uri="string",
 )
@@ -245,6 +242,41 @@ with client.database_connections.with_streaming_response.create(
 
 The context manager is required so that the response will reliably be closed.
 
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API.
+
+If you need to access undocumented endpoints, params, or response properties, the library can still be used.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
+http verbs. Options on the client will be respected (such as retries) will be respected when making this
+request.
+
+```py
+import httpx
+
+response = client.post(
+    "/foo",
+    cast_to=httpx.Response,
+    body={"my_param": True},
+)
+
+print(response.headers.get("x-foo"))
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
+options.
+
+#### Undocumented response properties
+
+To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
+can also get all the extra fields on the Pydantic model as a dict with
+[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
+
 ### 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:
@@ -254,13 +286,12 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 - Additional [advanced](https://www.python-httpx.org/advanced/#client-instances) functionality
 
 ```python
-import httpx
-from dataherald import Dataherald
+from dataherald import Dataherald, DefaultHttpxClient
 
 client = Dataherald(
     # Or use the `DATAHERALD_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
-    http_client=httpx.Client(
+    http_client=DefaultHttpxClient(
         proxies="http://my.test.proxy.example.com",
         transport=httpx.HTTPTransport(local_address="0.0.0.0"),
     ),