release: 1.0.0

.github/workflows/ci.yml

@@ -12,7 +12,6 @@ jobs:
   lint:
     name: lint
     runs-on: ubuntu-latest
-
 
     steps:
       - uses: actions/checkout@v4
@@ -30,6 +29,7 @@ jobs:
 
       - name: Run lints
         run: ./scripts/lint
+
   test:
     name: test
     runs-on: ubuntu-latest
@@ -50,4 +50,3 @@ jobs:
 
       - name: Run tests
         run: ./scripts/test
-

.github/workflows/publish-pypi.yml

@@ -0,0 +1,31 @@
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to PyPI in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/aurelio-labs/saturn-sdk/actions/workflows/publish-pypi.yml
+name: Publish PyPI
+on:
+  workflow_dispatch:
+
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rye
+        run: |
+          curl -sSf https://rye.astral.sh/get | bash
+          echo "$HOME/.rye/shims" >> $GITHUB_PATH
+        env:
+          RYE_VERSION: '0.35.0'
+          RYE_INSTALL_OPTION: '--yes'
+
+      - name: Publish to PyPI
+        run: |
+          bash ./bin/publish-pypi
+        env:
+          PYPI_TOKEN: ${{ secrets.SATURN_SDK_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.github/workflows/release-doctor.yml

@@ -0,0 +1,21 @@
+name: Release Doctor
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  release_doctor:
+    name: release doctor
+    runs-on: ubuntu-latest
+    if: github.repository == 'aurelio-labs/saturn-sdk' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check release environment
+        run: |
+          bash ./bin/check-release-environment
+        env:
+          PYPI_TOKEN: ${{ secrets.SATURN_SDK_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.0.0"
+}

CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+## 1.0.0 (2025-01-24)
+
+Full Changelog: [v0.0.1-alpha.0...v1.0.0](https://github.com/aurelio-labs/saturn-sdk/compare/v0.0.1-alpha.0...v1.0.0)
+
+### Bug Fixes
+
+* **client:** compat with new httpx 0.28.0 release ([#12](https://github.com/aurelio-labs/saturn-sdk/issues/12)) ([9496560](https://github.com/aurelio-labs/saturn-sdk/commit/949656070e2528907f8c4110b06037dfb5541144))
+* **client:** only call .close() when needed ([#27](https://github.com/aurelio-labs/saturn-sdk/issues/27)) ([19c05c1](https://github.com/aurelio-labs/saturn-sdk/commit/19c05c11fc3cb5664666577fa9424a8f0f35993d))
+* correctly handle deserialising `cls` fields ([#30](https://github.com/aurelio-labs/saturn-sdk/issues/30)) ([6a239be](https://github.com/aurelio-labs/saturn-sdk/commit/6a239be938cde2ee968f4a11ce8d1a7270dd9fb0))
+* **tests:** make test_get_platform less flaky ([#33](https://github.com/aurelio-labs/saturn-sdk/issues/33)) ([07e87fb](https://github.com/aurelio-labs/saturn-sdk/commit/07e87fbc0b6f5e004285c3782281b03a2ecb27c8))
+
+
+### Chores
+
+* add missing isclass check ([#25](https://github.com/aurelio-labs/saturn-sdk/issues/25)) ([b138aa2](https://github.com/aurelio-labs/saturn-sdk/commit/b138aa2217d46ae71915a57d2b1d50c3e9e68a5f))
+* go live ([#2](https://github.com/aurelio-labs/saturn-sdk/issues/2)) ([c50f2e3](https://github.com/aurelio-labs/saturn-sdk/commit/c50f2e3bc644002dc19ca09a8582c065c25ebfd7))
+* **internal:** add support for TypeAliasType ([#18](https://github.com/aurelio-labs/saturn-sdk/issues/18)) ([012f185](https://github.com/aurelio-labs/saturn-sdk/commit/012f185e872d2bb1cfe69c21fd54a3eac4927a4c))
+* **internal:** avoid pytest-asyncio deprecation warning ([#34](https://github.com/aurelio-labs/saturn-sdk/issues/34)) ([9852f5c](https://github.com/aurelio-labs/saturn-sdk/commit/9852f5c8483ad92057a19062a5826f1436cbf9cd))
+* **internal:** bump httpx dependency ([#26](https://github.com/aurelio-labs/saturn-sdk/issues/26)) ([f073ead](https://github.com/aurelio-labs/saturn-sdk/commit/f073ead590952975ef550b8405a1ed26c8bb4e02))
+* **internal:** bump pydantic dependency ([#15](https://github.com/aurelio-labs/saturn-sdk/issues/15)) ([b994cad](https://github.com/aurelio-labs/saturn-sdk/commit/b994cad420a17901c96610bf39c4aaadc9472d47))
+* **internal:** bump pyright ([#13](https://github.com/aurelio-labs/saturn-sdk/issues/13)) ([7bad95a](https://github.com/aurelio-labs/saturn-sdk/commit/7bad95ace6e68b8aff26127d52cf45629c139881))
+* **internal:** bump pyright ([#17](https://github.com/aurelio-labs/saturn-sdk/issues/17)) ([d3a4d21](https://github.com/aurelio-labs/saturn-sdk/commit/d3a4d21e1305aa5484ae1870dbfdafd2a5e5401b))
+* **internal:** codegen related update ([#10](https://github.com/aurelio-labs/saturn-sdk/issues/10)) ([3e29266](https://github.com/aurelio-labs/saturn-sdk/commit/3e29266f97ec32a234be097064a602b9f2464cfd))
+* **internal:** codegen related update ([#16](https://github.com/aurelio-labs/saturn-sdk/issues/16)) ([92a50ca](https://github.com/aurelio-labs/saturn-sdk/commit/92a50ca9173ea2c3f9437343ecb39b3e1d805414))
+* **internal:** codegen related update ([#19](https://github.com/aurelio-labs/saturn-sdk/issues/19)) ([5d2f003](https://github.com/aurelio-labs/saturn-sdk/commit/5d2f003392d4e997c3dd9910fada67a0241a3b78))
+* **internal:** codegen related update ([#20](https://github.com/aurelio-labs/saturn-sdk/issues/20)) ([3c4a607](https://github.com/aurelio-labs/saturn-sdk/commit/3c4a60796fd75663b448a8f0b66825910bf1fbe3))
+* **internal:** codegen related update ([#24](https://github.com/aurelio-labs/saturn-sdk/issues/24)) ([b61e7ed](https://github.com/aurelio-labs/saturn-sdk/commit/b61e7ed88590be73c969dddcbf0fe87b527b2f5a))
+* **internal:** codegen related update ([#29](https://github.com/aurelio-labs/saturn-sdk/issues/29)) ([3aad824](https://github.com/aurelio-labs/saturn-sdk/commit/3aad824477146e9d8ab4f9ec939d0ff3ef0cac8d))
+* **internal:** codegen related update ([#31](https://github.com/aurelio-labs/saturn-sdk/issues/31)) ([81219c4](https://github.com/aurelio-labs/saturn-sdk/commit/81219c442ddcdf4f37fc9c6003eb6eb7ccb54117))
+* **internal:** exclude mypy from running on tests ([#11](https://github.com/aurelio-labs/saturn-sdk/issues/11)) ([1156892](https://github.com/aurelio-labs/saturn-sdk/commit/1156892a1c090a82919671d408d11750afffa819))
+* **internal:** fix compat model_dump method when warnings are passed ([#8](https://github.com/aurelio-labs/saturn-sdk/issues/8)) ([9d3a8ee](https://github.com/aurelio-labs/saturn-sdk/commit/9d3a8eebf3c6d8cd17745831893cf6722a1f1a7c))
+* **internal:** fix some typos ([#23](https://github.com/aurelio-labs/saturn-sdk/issues/23)) ([98fbe0b](https://github.com/aurelio-labs/saturn-sdk/commit/98fbe0bbc6bdc94fa0b3169eef64407cfb5cc4bc))
+* **internal:** minor formatting changes ([#36](https://github.com/aurelio-labs/saturn-sdk/issues/36)) ([90f41d7](https://github.com/aurelio-labs/saturn-sdk/commit/90f41d761c156cdfef2cdcda2c3720ff5e32a851))
+* **internal:** minor style changes ([#35](https://github.com/aurelio-labs/saturn-sdk/issues/35)) ([c9214d6](https://github.com/aurelio-labs/saturn-sdk/commit/c9214d68a6341d9f7572bf4462bb72a215919f6d))
+* **internal:** updated imports ([#21](https://github.com/aurelio-labs/saturn-sdk/issues/21)) ([a005257](https://github.com/aurelio-labs/saturn-sdk/commit/a0052576dc057e155a4eaf6ad1bb70f04a3ead49))
+* make the `Omit` type public ([#14](https://github.com/aurelio-labs/saturn-sdk/issues/14)) ([917d726](https://github.com/aurelio-labs/saturn-sdk/commit/917d726ba7f1a26be49d11131229a6d87e59a8df))
+* rebuild project due to codegen change ([#5](https://github.com/aurelio-labs/saturn-sdk/issues/5)) ([3dd880d](https://github.com/aurelio-labs/saturn-sdk/commit/3dd880dbcbe7c76a679869c8fbd08c5b2f4c8e14))
+* rebuild project due to codegen change ([#6](https://github.com/aurelio-labs/saturn-sdk/issues/6)) ([c3ae73e](https://github.com/aurelio-labs/saturn-sdk/commit/c3ae73ecc3e7a728248643f610a2216aa2694fce))
+* rebuild project due to codegen change ([#7](https://github.com/aurelio-labs/saturn-sdk/issues/7)) ([a00bc72](https://github.com/aurelio-labs/saturn-sdk/commit/a00bc72c6615268aedac726bca8d65de836cef20))
+* update SDK settings ([#4](https://github.com/aurelio-labs/saturn-sdk/issues/4)) ([8b7cf8d](https://github.com/aurelio-labs/saturn-sdk/commit/8b7cf8d1f10ad9723020ed1633030992f0005ab3))
+
+
+### Documentation
+
+* add info log level to readme ([#9](https://github.com/aurelio-labs/saturn-sdk/issues/9)) ([24bf70d](https://github.com/aurelio-labs/saturn-sdk/commit/24bf70d8bc1c7f1e0efa5a96b0f24aba7bdb134d))
+* fix typos ([#28](https://github.com/aurelio-labs/saturn-sdk/issues/28)) ([f0f125e](https://github.com/aurelio-labs/saturn-sdk/commit/f0f125e432781fa649c1e202e105cb3621f83dbc))
+* **raw responses:** fix duplicate `the` ([#32](https://github.com/aurelio-labs/saturn-sdk/issues/32)) ([bc14d46](https://github.com/aurelio-labs/saturn-sdk/commit/bc14d4692ea53d6c291de7d73d2d8e4f5319b767))
+* **readme:** example snippet for client context manager ([#22](https://github.com/aurelio-labs/saturn-sdk/issues/22)) ([c3d36f2](https://github.com/aurelio-labs/saturn-sdk/commit/c3d36f25165cffac3f51a250fd5a9b6084193853))

CONTRIBUTING.md

@@ -2,9 +2,13 @@
 
 ### With Rye
 
-We use [Rye](https://rye.astral.sh/) to manage dependencies so we highly recommend [installing it](https://rye.astral.sh/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/saturn_sdk/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/saturn_sdk/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]/stainless-sdks/saturn-sdk-python.git
+```sh
+$ pip install git+ssh://[email protected]/aurelio-labs/saturn-sdk.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
@@ -117,7 +121,7 @@ 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/stainless-sdks/saturn-sdk-python/actions/workflows/publish-pypi.yml). This requires 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/aurelio-labs/saturn-sdk/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
 
 ### Publish manually
 

LICENSE

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