From f854b6df1e92cccaddbcbc3d36e52757abd65977 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 15 Mar 2025 22:10:16 +0000 Subject: [PATCH] chore: go live --- .github/workflows/publish-pypi.yml | 31 +++++++++++++ .github/workflows/release-doctor.yml | 21 +++++++++ .release-please-manifest.json | 3 ++ CONTRIBUTING.md | 4 +- README.md | 10 ++--- bin/check-release-environment | 21 +++++++++ pyproject.toml | 6 +-- release-please-config.json | 66 ++++++++++++++++++++++++++++ src/oxp/_version.py | 2 +- src/oxp/resources/health.py | 8 ++-- src/oxp/resources/tools.py | 8 ++-- 11 files changed, 161 insertions(+), 19 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..dcd4fcc --- /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/OpenExecProtocol/oxp-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.44.0' + RYE_INSTALL_OPTION: '--yes' + + - name: Publish to PyPI + run: | + bash ./bin/publish-pypi + env: + PYPI_TOKEN: ${{ secrets.OXP_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..0e734ee --- /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 == 'OpenExecProtocol/oxp-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.OXP_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 2338d36..28875d6 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/oxp-python.git +$ pip install git+ssh://git@github.com/OpenExecProtocol/oxp-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/oxp-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/OpenExecProtocol/oxp-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 fd463ec..6d958f4 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ The REST API documentation can be found on [openexecprotocol.org](https://openex ## Installation ```sh -# install from this staging repo -pip install git+ssh://git@github.com/stainless-sdks/oxp-python.git +# install from the production repo +pip install git+ssh://git@github.com/OpenExecProtocol/oxp-python.git ``` > [!NOTE] @@ -239,9 +239,9 @@ health = response.parse() # get the object that `health.check()` would have ret print(health) ``` -These methods return an [`APIResponse`](https://github.com/stainless-sdks/oxp-python/tree/main/src/oxp/_response.py) object. +These methods return an [`APIResponse`](https://github.com/OpenExecProtocol/oxp-python/tree/main/src/oxp/_response.py) object. -The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/oxp-python/tree/main/src/oxp/_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/OpenExecProtocol/oxp-python/tree/main/src/oxp/_response.py) with the same structure, the only difference being `await`able methods for reading the response content. #### `.with_streaming_response` @@ -345,7 +345,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/oxp-python/issues) with questions, bugs, or suggestions. +We are keen for your feedback; please open an [issue](https://www.github.com/OpenExecProtocol/oxp-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..575c254 --- /dev/null +++ b/bin/check-release-environment @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +errors=() + +if [ -z "${PYPI_TOKEN}" ]; then + errors+=("The OXP_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 bfe78a2..4408e34 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -34,8 +34,8 @@ classifiers = [ ] [project.urls] -Homepage = "https://github.com/stainless-sdks/oxp-python" -Repository = "https://github.com/stainless-sdks/oxp-python" +Homepage = "https://github.com/OpenExecProtocol/oxp-python" +Repository = "https://github.com/OpenExecProtocol/oxp-python" [tool.rye] @@ -121,7 +121,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/oxp-python/tree/main/\g<2>)' +replacement = '[\1](https://github.com/OpenExecProtocol/oxp-python/tree/main/\g<2>)' [tool.pytest.ini_options] testpaths = ["tests"] diff --git a/release-please-config.json b/release-please-config.json new file mode 100644 index 0000000..767b10a --- /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/oxp/_version.py" + ] +} \ No newline at end of file diff --git a/src/oxp/_version.py b/src/oxp/_version.py index 2d44ba3..ee66a8b 100644 --- a/src/oxp/_version.py +++ b/src/oxp/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "oxp" -__version__ = "0.0.1-alpha.0" +__version__ = "0.0.1-alpha.0" # x-release-please-version diff --git a/src/oxp/resources/health.py b/src/oxp/resources/health.py index 0a7dfd0..6d83e2b 100644 --- a/src/oxp/resources/health.py +++ b/src/oxp/resources/health.py @@ -25,7 +25,7 @@ def with_raw_response(self) -> HealthResourceWithRawResponse: This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content. - For more information, see https://www.github.com/stainless-sdks/oxp-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/OpenExecProtocol/oxp-python#accessing-raw-response-data-eg-headers """ return HealthResourceWithRawResponse(self) @@ -34,7 +34,7 @@ def with_streaming_response(self) -> HealthResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/oxp-python#with_streaming_response + For more information, see https://www.github.com/OpenExecProtocol/oxp-python#with_streaming_response """ return HealthResourceWithStreamingResponse(self) @@ -66,7 +66,7 @@ def with_raw_response(self) -> AsyncHealthResourceWithRawResponse: This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content. - For more information, see https://www.github.com/stainless-sdks/oxp-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/OpenExecProtocol/oxp-python#accessing-raw-response-data-eg-headers """ return AsyncHealthResourceWithRawResponse(self) @@ -75,7 +75,7 @@ def with_streaming_response(self) -> AsyncHealthResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/oxp-python#with_streaming_response + For more information, see https://www.github.com/OpenExecProtocol/oxp-python#with_streaming_response """ return AsyncHealthResourceWithStreamingResponse(self) diff --git a/src/oxp/resources/tools.py b/src/oxp/resources/tools.py index 0357db1..d0a35a0 100644 --- a/src/oxp/resources/tools.py +++ b/src/oxp/resources/tools.py @@ -32,7 +32,7 @@ def with_raw_response(self) -> ToolsResourceWithRawResponse: This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content. - For more information, see https://www.github.com/stainless-sdks/oxp-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/OpenExecProtocol/oxp-python#accessing-raw-response-data-eg-headers """ return ToolsResourceWithRawResponse(self) @@ -41,7 +41,7 @@ def with_streaming_response(self) -> ToolsResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/oxp-python#with_streaming_response + For more information, see https://www.github.com/OpenExecProtocol/oxp-python#with_streaming_response """ return ToolsResourceWithStreamingResponse(self) @@ -111,7 +111,7 @@ def with_raw_response(self) -> AsyncToolsResourceWithRawResponse: This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content. - For more information, see https://www.github.com/stainless-sdks/oxp-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/OpenExecProtocol/oxp-python#accessing-raw-response-data-eg-headers """ return AsyncToolsResourceWithRawResponse(self) @@ -120,7 +120,7 @@ def with_streaming_response(self) -> AsyncToolsResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/oxp-python#with_streaming_response + For more information, see https://www.github.com/OpenExecProtocol/oxp-python#with_streaming_response """ return AsyncToolsResourceWithStreamingResponse(self)