release: 0.20.1

.devcontainer/Dockerfile

@@ -3,7 +3,7 @@ FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
 
 USER vscode
 
-RUN curl -sSf https://rye-up.com/get | RYE_VERSION="0.24.0" RYE_INSTALL_OPTION="--yes" bash
+RUN curl -sSf https://rye.astral.sh/get | RYE_VERSION="0.35.0" RYE_INSTALL_OPTION="--yes" bash
 ENV PATH=/home/vscode/.rye/shims:$PATH
 
 RUN echo "[[ -d .venv ]] && source .venv/bin/activate" >> /home/vscode/.bashrc

.github/workflows/ci.yml

@@ -6,6 +6,7 @@ on:
   pull_request:
     branches:
       - main
+      - next
 
 jobs:
   lint:
@@ -18,27 +19,17 @@ jobs:
 
       - name: Install Rye
         run: |
-          curl -sSf https://rye-up.com/get | bash
+          curl -sSf https://rye.astral.sh/get | bash
           echo "$HOME/.rye/shims" >> $GITHUB_PATH
         env:
-          RYE_VERSION: 0.24.0
+          RYE_VERSION: '0.35.0'
           RYE_INSTALL_OPTION: '--yes'
 
       - name: Install dependencies
-        run: |
-          rye sync --all-features
-
-      - name: Run ruff
-        run: |
-          rye run check:ruff
+        run: rye sync --all-features
 
-      - name: Run type checking
-        run: |
-          rye run typecheck
-
-      - name: Ensure importable
-        run: |
-          rye run python -c 'import dataherald'
+      - name: Run lints
+        run: ./scripts/lint
   test:
     name: test
     runs-on: ubuntu-latest
@@ -48,10 +39,10 @@ jobs:
 
       - name: Install Rye
         run: |
-          curl -sSf https://rye-up.com/get | bash
+          curl -sSf https://rye.astral.sh/get | bash
           echo "$HOME/.rye/shims" >> $GITHUB_PATH
         env:
-          RYE_VERSION: 0.24.0
+          RYE_VERSION: '0.35.0'
           RYE_INSTALL_OPTION: '--yes'
 
       - name: Bootstrap

.github/workflows/publish-pypi.yml

@@ -18,11 +18,11 @@ jobs:
 
       - name: Install Rye
         run: |
-          curl -sSf https://rye-up.com/get | bash
+          curl -sSf https://rye.astral.sh/get | bash
           echo "$HOME/.rye/shims" >> $GITHUB_PATH
         env:
-          RYE_VERSION: 0.24.0
-          RYE_INSTALL_OPTION: "--yes"
+          RYE_VERSION: '0.35.0'
+          RYE_INSTALL_OPTION: '--yes'
 
       - name: Publish to PyPI
         run: |

.github/workflows/release-doctor.yml

@@ -1,6 +1,8 @@
 name: Release Doctor
 on:
   pull_request:
+    branches:
+      - main
   workflow_dispatch:
 
 jobs:

.gitignore

@@ -1,3 +1,4 @@
+.prism.log
 .vscode
 _dev
 

.release-please-manifest.json

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

CHANGELOG.md

@@ -1,5 +1,58 @@
 # Changelog
 
+## 0.20.1 (2025-01-09)
+
+Full Changelog: [v0.20.0...v0.20.1](https://github.com/Dataherald/dataherald-python/compare/v0.20.0...v0.20.1)
+
+### Bug Fixes
+
+* **client:** compat with new httpx 0.28.0 release ([#65](https://github.com/Dataherald/dataherald-python/issues/65)) ([9ee84bd](https://github.com/Dataherald/dataherald-python/commit/9ee84bd044e4fd133b94e0346dff772ea62ec152))
+* **client:** only call .close() when needed ([#90](https://github.com/Dataherald/dataherald-python/issues/90)) ([071db7c](https://github.com/Dataherald/dataherald-python/commit/071db7c123939fc97e425f143040b32c941f49a7))
+
+
+### Chores
+
+* add missing isclass check ([#88](https://github.com/Dataherald/dataherald-python/issues/88)) ([cc7a473](https://github.com/Dataherald/dataherald-python/commit/cc7a47330003f951306e3e313722c2a5020e8a3e))
+* **internal:** add support for TypeAliasType ([#71](https://github.com/Dataherald/dataherald-python/issues/71)) ([911abd4](https://github.com/Dataherald/dataherald-python/commit/911abd4190cbc49d96fa291c0be303440fc651e7))
+* **internal:** bump httpx dependency ([#89](https://github.com/Dataherald/dataherald-python/issues/89)) ([c37a99c](https://github.com/Dataherald/dataherald-python/commit/c37a99ced506fa058866003013a9a5410871d0c8))
+* **internal:** bump pydantic dependency ([#68](https://github.com/Dataherald/dataherald-python/issues/68)) ([13d4ec2](https://github.com/Dataherald/dataherald-python/commit/13d4ec203e3b194ec38c33b8582288e344a16f19))
+* **internal:** bump pyright ([#66](https://github.com/Dataherald/dataherald-python/issues/66)) ([9d5db21](https://github.com/Dataherald/dataherald-python/commit/9d5db21aae350d5eb3fa5a52cb72a8fcab17f0c2))
+* **internal:** bump pyright ([#70](https://github.com/Dataherald/dataherald-python/issues/70)) ([2a732e0](https://github.com/Dataherald/dataherald-python/commit/2a732e03fafe75f1b0ab7812176259a9c311f2bc))
+* **internal:** codegen related update ([#64](https://github.com/Dataherald/dataherald-python/issues/64)) ([5ba7000](https://github.com/Dataherald/dataherald-python/commit/5ba70006e6e4c0addb3461eaec8424d45d12c3c5))
+* **internal:** codegen related update ([#72](https://github.com/Dataherald/dataherald-python/issues/72)) ([6ddf080](https://github.com/Dataherald/dataherald-python/commit/6ddf080b63f5fb373d1fd32ec4919baada704b64))
+* **internal:** codegen related update ([#73](https://github.com/Dataherald/dataherald-python/issues/73)) ([d8c41ed](https://github.com/Dataherald/dataherald-python/commit/d8c41ed0a8cf93d7839a61ab572da71262f0c0db))
+* **internal:** codegen related update ([#74](https://github.com/Dataherald/dataherald-python/issues/74)) ([b6bb66d](https://github.com/Dataherald/dataherald-python/commit/b6bb66d23275d077c6f2defcf076dc9b23c270bf))
+* **internal:** codegen related update ([#75](https://github.com/Dataherald/dataherald-python/issues/75)) ([4b98a96](https://github.com/Dataherald/dataherald-python/commit/4b98a9631848d80f30c22aee9c3c0817770aee28))
+* **internal:** codegen related update ([#76](https://github.com/Dataherald/dataherald-python/issues/76)) ([2ab6503](https://github.com/Dataherald/dataherald-python/commit/2ab650352fdc1f7a49f0bbd553b53ad47a81dce7))
+* **internal:** codegen related update ([#77](https://github.com/Dataherald/dataherald-python/issues/77)) ([694418c](https://github.com/Dataherald/dataherald-python/commit/694418c48ff2842cb2c41699729baee90754488d))
+* **internal:** codegen related update ([#78](https://github.com/Dataherald/dataherald-python/issues/78)) ([dcf8544](https://github.com/Dataherald/dataherald-python/commit/dcf8544e5f5edd785eb6cb6768106d44877a5c70))
+* **internal:** codegen related update ([#79](https://github.com/Dataherald/dataherald-python/issues/79)) ([2dbb767](https://github.com/Dataherald/dataherald-python/commit/2dbb7674a7c3db79fec9ca141b4283c2f050c918))
+* **internal:** codegen related update ([#80](https://github.com/Dataherald/dataherald-python/issues/80)) ([412f142](https://github.com/Dataherald/dataherald-python/commit/412f142303414a7fde0763aa72cdc74c31a8998d))
+* **internal:** codegen related update ([#81](https://github.com/Dataherald/dataherald-python/issues/81)) ([031e5b8](https://github.com/Dataherald/dataherald-python/commit/031e5b84710ee455ce19eba2b8d5148134b4fe31))
+* **internal:** codegen related update ([#83](https://github.com/Dataherald/dataherald-python/issues/83)) ([5bcb54b](https://github.com/Dataherald/dataherald-python/commit/5bcb54b4145ad3cbb0fa753f509db7838237e869))
+* **internal:** codegen related update ([#84](https://github.com/Dataherald/dataherald-python/issues/84)) ([f9b8c6a](https://github.com/Dataherald/dataherald-python/commit/f9b8c6a812e0dc7607caccda8c45d7170d77af5e))
+* **internal:** codegen related update ([#85](https://github.com/Dataherald/dataherald-python/issues/85)) ([f349307](https://github.com/Dataherald/dataherald-python/commit/f34930770a07b9553337b9a214883092035f442a))
+* **internal:** codegen related update ([#86](https://github.com/Dataherald/dataherald-python/issues/86)) ([57946cb](https://github.com/Dataherald/dataherald-python/commit/57946cb1c1f04f1dc9b9bc64d9406267a29efb2f))
+* **internal:** codegen related update ([#87](https://github.com/Dataherald/dataherald-python/issues/87)) ([7dbadda](https://github.com/Dataherald/dataherald-python/commit/7dbadda36b312ae2e93433aa2cbb0d41c4055705))
+* **internal:** codegen related update ([#92](https://github.com/Dataherald/dataherald-python/issues/92)) ([ac962fb](https://github.com/Dataherald/dataherald-python/commit/ac962fb29ea9fbb91e308f580e726a3eb778fc6a))
+* **internal:** fix compat model_dump method when warnings are passed ([#61](https://github.com/Dataherald/dataherald-python/issues/61)) ([6fedf36](https://github.com/Dataherald/dataherald-python/commit/6fedf36fd30a8a1ccbcb8633f85d999f0b38ec34))
+* **internal:** fix some typos ([#82](https://github.com/Dataherald/dataherald-python/issues/82)) ([476ccee](https://github.com/Dataherald/dataherald-python/commit/476ccee978ece6c6e855f63e680f30aeaa4c3e18))
+* **internal:** version bump ([#54](https://github.com/Dataherald/dataherald-python/issues/54)) ([762488e](https://github.com/Dataherald/dataherald-python/commit/762488ecc8e55fb18e05b90a7cb353bea9ee6a00))
+* make the `Omit` type public ([#67](https://github.com/Dataherald/dataherald-python/issues/67)) ([3070bff](https://github.com/Dataherald/dataherald-python/commit/3070bff7d602bd234433ad802c92b9fba210a852))
+* rebuild project due to codegen change ([#56](https://github.com/Dataherald/dataherald-python/issues/56)) ([3f06cb7](https://github.com/Dataherald/dataherald-python/commit/3f06cb70c1ef852ec71f9b4763f991ffcf3e1562))
+* rebuild project due to codegen change ([#57](https://github.com/Dataherald/dataherald-python/issues/57)) ([eaf1330](https://github.com/Dataherald/dataherald-python/commit/eaf13302cfbaf6c7ed61717be1ce9359d716cbdf))
+* rebuild project due to codegen change ([#58](https://github.com/Dataherald/dataherald-python/issues/58)) ([2e4560f](https://github.com/Dataherald/dataherald-python/commit/2e4560f29d5e27c88dbcfd80aaa84fca1e64133b))
+* rebuild project due to codegen change ([#59](https://github.com/Dataherald/dataherald-python/issues/59)) ([7728427](https://github.com/Dataherald/dataherald-python/commit/7728427bca7e453c0897e599c2cb6e80b558e80e))
+* rebuild project due to codegen change ([#60](https://github.com/Dataherald/dataherald-python/issues/60)) ([6742d13](https://github.com/Dataherald/dataherald-python/commit/6742d13cf6e40582d84e19aa085ef36f6359fb4c))
+* remove now unused `cached-property` dep ([#63](https://github.com/Dataherald/dataherald-python/issues/63)) ([540b49a](https://github.com/Dataherald/dataherald-python/commit/540b49a21e53183ac7a5eb670b375e3ded2ecf34))
+
+
+### Documentation
+
+* add info log level to readme ([#62](https://github.com/Dataherald/dataherald-python/issues/62)) ([175f6b8](https://github.com/Dataherald/dataherald-python/commit/175f6b8f5e544c979425b1a4c37be9a04162ceb8))
+* fix typos ([#91](https://github.com/Dataherald/dataherald-python/issues/91)) ([e3b409c](https://github.com/Dataherald/dataherald-python/commit/e3b409cb56dda58af9dca833b74a802682e5d9db))
+* **readme:** fix http client proxies example ([#69](https://github.com/Dataherald/dataherald-python/issues/69)) ([f0129cf](https://github.com/Dataherald/dataherald-python/commit/f0129cf790bb9849d6c64bae68b912756006e9da))
+
 ## 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)

CONTRIBUTING.md

@@ -2,9 +2,13 @@
 
 ### With Rye
 
-We use [Rye](https://rye-up.com/) to manage dependencies so we highly recommend [installing it](https://rye-up.com/guide/installation/) as it will automatically provision a Python environment with the expected Python version.
+We use [Rye](https://rye.astral.sh/) to manage dependencies because it will automatically provision a Python environment with the expected Python version. To set it up, run:
 
-After installing Rye, you'll just have to run this command:
+```sh
+$ ./scripts/bootstrap
+```
+
+Or [install Rye manually](https://rye.astral.sh/guide/installation/) and run:
 
 ```sh
 $ rye sync --all-features
@@ -31,25 +35,25 @@ $ pip install -r requirements-dev.lock
 
 ## Modifying/Adding code
 
-Most of the SDK is generated code, and any modified code will be overridden on the next generation. The
-`src/dataherald/lib/` and `examples/` directories are exceptions and will never be overridden.
+Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
+result in merge conflicts between manual patches and changes from the generator. The generator will never
+modify the contents of the `src/dataherald/lib/` and `examples/` directories.
 
 ## Adding and running examples
 
-All files in the `examples/` directory are not modified by the Stainless generator and can be freely edited or
-added to.
+All files in the `examples/` directory are not modified by the generator and can be freely edited or added to.
 
-```bash
+```py
 # add an example to examples/<your-example>.py
 
 #!/usr/bin/env -S rye run python
 …
 ```
 
-```
-chmod +x examples/<your-example>.py
+```sh
+$ chmod +x examples/<your-example>.py
 # run the example against your api
-./examples/<your-example>.py
+$ ./examples/<your-example>.py
 ```
 
 ## Using the repository from source
@@ -58,8 +62,8 @@ 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
+```sh
+$ pip install git+ssh://[email protected]/Dataherald/dataherald-python#main.git
 ```
 
 Alternatively, you can build from source and install the wheel file:
@@ -68,29 +72,29 @@ Building this package will create two files in the `dist/` directory, a `.tar.gz
 
 To create a distributable version of the library, all you have to do is run this command:
 
-```bash
-rye build
+```sh
+$ rye build
 # or
-python -m build
+$ python -m build
 ```
 
 Then to install:
 
 ```sh
-pip install ./path-to-wheel-file.whl
+$ pip install ./path-to-wheel-file.whl
 ```
 
 ## Running 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
+```sh
 # you will need npm installed
-npx prism mock path/to/your/openapi.yml
+$ npx prism mock path/to/your/openapi.yml
 ```
 
-```bash
-rye run pytest
+```sh
+$ ./scripts/test
 ```
 
 ## Linting and formatting
@@ -100,14 +104,14 @@ This repository uses [ruff](https://github.com/astral-sh/ruff) and
 
 To lint:
 
-```bash
-rye run lint
+```sh
+$ ./scripts/lint
 ```
 
 To format and fix all ruff issues automatically:
 
-```bash
-rye run format
+```sh
+$ ./scripts/format
 ```
 
 ## Publishing and releases

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 Dataherald
+   Copyright 2025 Dataherald
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.