From 4d80dcc27b29333c398502ca08e8cd4f9e82e6e4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 17 Oct 2024 17:07:27 +0000 Subject: [PATCH 1/2] feat(api): api update (#1) --- .github/workflows/publish-pypi.yml | 31 +++++++++ .github/workflows/release-doctor.yml | 21 ++++++ .release-please-manifest.json | 3 + CONTRIBUTING.md | 4 +- README.md | 13 ++-- bin/check-release-environment | 21 ++++++ pyproject.toml | 6 +- release-please-config.json | 66 +++++++++++++++++++ src/omnistack/_version.py | 2 +- src/omnistack/resources/openai/chat.py | 8 +-- src/omnistack/resources/openai/completions.py | 8 +-- src/omnistack/resources/openai/openai.py | 8 +-- 12 files changed, 165 insertions(+), 26 deletions(-) create mode 100644 .github/workflows/publish-pypi.yml create mode 100644 .github/workflows/release-doctor.yml create mode 100644 .release-please-manifest.json create mode 100644 bin/check-release-environment create mode 100644 release-please-config.json diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml new file mode 100644 index 0000000..b882da0 --- /dev/null +++ b/.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/OmniStack-sh/omnistack-python/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.OMNISTACK_PYPI_TOKEN || secrets.PYPI_TOKEN }} diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml new file mode 100644 index 0000000..a0ec8c5 --- /dev/null +++ b/.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 == 'OmniStack-sh/omnistack-python' && (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.OMNISTACK_PYPI_TOKEN || secrets.PYPI_TOKEN }} diff --git a/.release-please-manifest.json b/.release-please-manifest.json new file mode 100644 index 0000000..c476280 --- /dev/null +++ b/.release-please-manifest.json @@ -0,0 +1,3 @@ +{ + ".": "0.0.1-alpha.0" +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7629cdf..380b73c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,7 +63,7 @@ If you’d like to use the repository from source, you can either install from g To install via git: ```sh -$ pip install git+ssh://git@github.com/stainless-sdks/omnistack-python.git +$ pip install git+ssh://git@github.com/OmniStack-sh/omnistack-python.git ``` Alternatively, you can build from source and install the wheel file: @@ -121,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/omnistack-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/OmniStack-sh/omnistack-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up. ### Publish manually diff --git a/README.md b/README.md index f43374b..c3aefac 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,10 @@ The REST API documentation can be found on [docs.omnistack.com](https://docs.omn ## Installation ```sh -# install from this staging repo -pip install git+ssh://git@github.com/stainless-sdks/omnistack-python.git +# install from PyPI +pip install --pre omnistack ``` -> [!NOTE] -> Once this package is [published to PyPI](https://app.stainlessapi.com/docs/guides/publish), this will become: `pip install --pre omnistack` - ## Usage The full API of this library can be found in [api.md](api.md). @@ -214,9 +211,9 @@ completion = response.parse() # get the object that `openai.completions.create( print(completion) ``` -These methods return an [`APIResponse`](https://github.com/stainless-sdks/omnistack-python/tree/main/src/omnistack/_response.py) object. +These methods return an [`APIResponse`](https://github.com/OmniStack-sh/omnistack-python/tree/main/src/omnistack/_response.py) object. -The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/omnistack-python/tree/main/src/omnistack/_response.py) with the same structure, the only difference being `await`able methods for reading the response content. +The async client returns an [`AsyncAPIResponse`](https://github.com/OmniStack-sh/omnistack-python/tree/main/src/omnistack/_response.py) with the same structure, the only difference being `await`able methods for reading the response content. #### `.with_streaming_response` @@ -313,7 +310,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience. -We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/omnistack-python/issues) with questions, bugs, or suggestions. +We are keen for your feedback; please open an [issue](https://www.github.com/OmniStack-sh/omnistack-python/issues) with questions, bugs, or suggestions. ### Determining the installed version diff --git a/bin/check-release-environment b/bin/check-release-environment new file mode 100644 index 0000000..e3136a8 --- /dev/null +++ b/bin/check-release-environment @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +errors=() + +if [ -z "${PYPI_TOKEN}" ]; then + errors+=("The OMNISTACK_PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.") +fi + +lenErrors=${#errors[@]} + +if [[ lenErrors -gt 0 ]]; then + echo -e "Found the following errors in the release environment:\n" + + for error in "${errors[@]}"; do + echo -e "- $error\n" + done + + exit 1 +fi + +echo "The environment is ready to push releases!" diff --git a/pyproject.toml b/pyproject.toml index 22c91c4..07cb400 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,8 +36,8 @@ classifiers = [ ] [project.urls] -Homepage = "https://github.com/stainless-sdks/omnistack-python" -Repository = "https://github.com/stainless-sdks/omnistack-python" +Homepage = "https://github.com/OmniStack-sh/omnistack-python" +Repository = "https://github.com/OmniStack-sh/omnistack-python" @@ -123,7 +123,7 @@ path = "README.md" [[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]] # replace relative links with absolute links pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)' -replacement = '[\1](https://github.com/stainless-sdks/omnistack-python/tree/main/\g<2>)' +replacement = '[\1](https://github.com/OmniStack-sh/omnistack-python/tree/main/\g<2>)' [tool.black] line-length = 120 diff --git a/release-please-config.json b/release-please-config.json new file mode 100644 index 0000000..1fe4384 --- /dev/null +++ b/release-please-config.json @@ -0,0 +1,66 @@ +{ + "packages": { + ".": {} + }, + "$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json", + "include-v-in-tag": true, + "include-component-in-tag": false, + "versioning": "prerelease", + "prerelease": true, + "bump-minor-pre-major": true, + "bump-patch-for-minor-pre-major": false, + "pull-request-header": "Automated Release PR", + "pull-request-title-pattern": "release: ${version}", + "changelog-sections": [ + { + "type": "feat", + "section": "Features" + }, + { + "type": "fix", + "section": "Bug Fixes" + }, + { + "type": "perf", + "section": "Performance Improvements" + }, + { + "type": "revert", + "section": "Reverts" + }, + { + "type": "chore", + "section": "Chores" + }, + { + "type": "docs", + "section": "Documentation" + }, + { + "type": "style", + "section": "Styles" + }, + { + "type": "refactor", + "section": "Refactors" + }, + { + "type": "test", + "section": "Tests", + "hidden": true + }, + { + "type": "build", + "section": "Build System" + }, + { + "type": "ci", + "section": "Continuous Integration", + "hidden": true + } + ], + "release-type": "python", + "extra-files": [ + "src/omnistack/_version.py" + ] +} \ No newline at end of file diff --git a/src/omnistack/_version.py b/src/omnistack/_version.py index ca6d3a1..c178860 100644 --- a/src/omnistack/_version.py +++ b/src/omnistack/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "omnistack" -__version__ = "0.0.1-alpha.0" +__version__ = "0.0.1-alpha.0" # x-release-please-version diff --git a/src/omnistack/resources/openai/chat.py b/src/omnistack/resources/openai/chat.py index 474217b..8a17f3e 100644 --- a/src/omnistack/resources/openai/chat.py +++ b/src/omnistack/resources/openai/chat.py @@ -34,7 +34,7 @@ def with_raw_response(self) -> ChatResourceWithRawResponse: This property can be used as a prefix for any HTTP method call to return the the raw response object instead of the parsed content. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers """ return ChatResourceWithRawResponse(self) @@ -43,7 +43,7 @@ def with_streaming_response(self) -> ChatResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response """ return ChatResourceWithStreamingResponse(self) @@ -302,7 +302,7 @@ def with_raw_response(self) -> AsyncChatResourceWithRawResponse: This property can be used as a prefix for any HTTP method call to return the the raw response object instead of the parsed content. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers """ return AsyncChatResourceWithRawResponse(self) @@ -311,7 +311,7 @@ def with_streaming_response(self) -> AsyncChatResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response """ return AsyncChatResourceWithStreamingResponse(self) diff --git a/src/omnistack/resources/openai/completions.py b/src/omnistack/resources/openai/completions.py index e48207f..b6c287d 100644 --- a/src/omnistack/resources/openai/completions.py +++ b/src/omnistack/resources/openai/completions.py @@ -34,7 +34,7 @@ def with_raw_response(self) -> CompletionsResourceWithRawResponse: This property can be used as a prefix for any HTTP method call to return the the raw response object instead of the parsed content. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers """ return CompletionsResourceWithRawResponse(self) @@ -43,7 +43,7 @@ def with_streaming_response(self) -> CompletionsResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response """ return CompletionsResourceWithStreamingResponse(self) @@ -241,7 +241,7 @@ def with_raw_response(self) -> AsyncCompletionsResourceWithRawResponse: This property can be used as a prefix for any HTTP method call to return the the raw response object instead of the parsed content. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers """ return AsyncCompletionsResourceWithRawResponse(self) @@ -250,7 +250,7 @@ def with_streaming_response(self) -> AsyncCompletionsResourceWithStreamingRespon """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response """ return AsyncCompletionsResourceWithStreamingResponse(self) diff --git a/src/omnistack/resources/openai/openai.py b/src/omnistack/resources/openai/openai.py index 529c291..5e1f232 100644 --- a/src/omnistack/resources/openai/openai.py +++ b/src/omnistack/resources/openai/openai.py @@ -39,7 +39,7 @@ def with_raw_response(self) -> OpenAIResourceWithRawResponse: This property can be used as a prefix for any HTTP method call to return the the raw response object instead of the parsed content. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers """ return OpenAIResourceWithRawResponse(self) @@ -48,7 +48,7 @@ def with_streaming_response(self) -> OpenAIResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response """ return OpenAIResourceWithStreamingResponse(self) @@ -68,7 +68,7 @@ def with_raw_response(self) -> AsyncOpenAIResourceWithRawResponse: This property can be used as a prefix for any HTTP method call to return the the raw response object instead of the parsed content. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#accessing-raw-response-data-eg-headers """ return AsyncOpenAIResourceWithRawResponse(self) @@ -77,7 +77,7 @@ def with_streaming_response(self) -> AsyncOpenAIResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/omnistack-python#with_streaming_response + For more information, see https://www.github.com/OmniStack-sh/omnistack-python#with_streaming_response """ return AsyncOpenAIResourceWithStreamingResponse(self) From 0392c979b6c3d1654779ea3df04c4ffcc568c283 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 17 Oct 2024 17:07:39 +0000 Subject: [PATCH 2/2] release: 0.1.0-alpha.1 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 11 +++++++++++ pyproject.toml | 2 +- src/omnistack/_version.py | 2 +- 4 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 CHANGELOG.md diff --git a/.release-please-manifest.json b/.release-please-manifest.json index c476280..ba6c348 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.0.1-alpha.0" + ".": "0.1.0-alpha.1" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2f4a4fc --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + +## 0.1.0-alpha.1 (2024-10-17) + +Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/OmniStack-sh/omnistack-python/compare/v0.0.1-alpha.0...v0.1.0-alpha.1) + +### Features + +* **api:** api update ([7d28614](https://github.com/OmniStack-sh/omnistack-python/commit/7d28614ac5d0b945e7b6df013d5c9c63522760c5)) +* **api:** api update ([#1](https://github.com/OmniStack-sh/omnistack-python/issues/1)) ([4d80dcc](https://github.com/OmniStack-sh/omnistack-python/commit/4d80dcc27b29333c398502ca08e8cd4f9e82e6e4)) +* **api:** update via SDK Studio ([55e43c9](https://github.com/OmniStack-sh/omnistack-python/commit/55e43c987366864154869a6f7c91ad267ce612dc)) diff --git a/pyproject.toml b/pyproject.toml index 07cb400..346fe76 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "omnistack" -version = "0.0.1-alpha.0" +version = "0.1.0-alpha.1" description = "The official Python library for the omnistack API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/src/omnistack/_version.py b/src/omnistack/_version.py index c178860..c077bff 100644 --- a/src/omnistack/_version.py +++ b/src/omnistack/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "omnistack" -__version__ = "0.0.1-alpha.0" # x-release-please-version +__version__ = "0.1.0-alpha.1" # x-release-please-version