From b8be4a51ff1a7ba9775448430f4e77b11aaaaa6c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 9 Jul 2024 16:52:27 +0000 Subject: [PATCH 1/3] chore: go live (#2) --- .github/workflows/create-releases.yml | 38 ------------------- .../handle-release-pr-title-edit.yml | 25 ------------ .github/workflows/publish-pypi.yml | 8 +++- .github/workflows/release-doctor.yml | 3 +- CONTRIBUTING.md | 4 +- README.md | 8 ++-- bin/check-release-environment | 4 -- pyproject.toml | 6 +-- 8 files changed, 16 insertions(+), 80 deletions(-) delete mode 100644 .github/workflows/create-releases.yml delete mode 100644 .github/workflows/handle-release-pr-title-edit.yml diff --git a/.github/workflows/create-releases.yml b/.github/workflows/create-releases.yml deleted file mode 100644 index a346d1d..0000000 --- a/.github/workflows/create-releases.yml +++ /dev/null @@ -1,38 +0,0 @@ -name: Create releases -on: - schedule: - - cron: '0 5 * * *' # every day at 5am UTC - push: - branches: - - main - -jobs: - release: - name: release - if: github.ref == 'refs/heads/main' && github.repository == 'sachnk/studio-sdk-python' - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - - uses: stainless-api/trigger-release-please@v1 - id: release - with: - repo: ${{ github.event.repository.full_name }} - stainless-api-key: ${{ secrets.STAINLESS_API_KEY }} - - - name: Install Rye - if: ${{ steps.release.outputs.releases_created }} - 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 - if: ${{ steps.release.outputs.releases_created }} - run: | - bash ./bin/publish-pypi - env: - PYPI_TOKEN: ${{ secrets.STUDIO_SDK_PYPI_TOKEN || secrets.PYPI_TOKEN }} diff --git a/.github/workflows/handle-release-pr-title-edit.yml b/.github/workflows/handle-release-pr-title-edit.yml deleted file mode 100644 index a7342e6..0000000 --- a/.github/workflows/handle-release-pr-title-edit.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Handle release PR title edits -on: - pull_request: - types: - - edited - - unlabeled - -jobs: - update_pr_content: - name: Update pull request content - if: | - ((github.event.action == 'edited' && github.event.changes.title.from != github.event.pull_request.title) || - (github.event.action == 'unlabeled' && github.event.label.name == 'autorelease: custom version')) && - startsWith(github.event.pull_request.head.ref, 'release-please--') && - github.event.pull_request.state == 'open' && - github.event.sender.login != 'stainless-bot' && - github.event.sender.login != 'stainless-app' && - github.repository == 'sachnk/studio-sdk-python' - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: stainless-api/trigger-release-please@v1 - with: - repo: ${{ github.event.repository.full_name }} - stainless-api-key: ${{ secrets.STAINLESS_API_KEY }} diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml index 41b4233..63c198a 100644 --- a/.github/workflows/publish-pypi.yml +++ b/.github/workflows/publish-pypi.yml @@ -1,9 +1,13 @@ -# workflow for re-running publishing to PyPI in case it fails for some reason -# you can run this workflow by navigating to https://www.github.com/sachnk/studio-sdk-python/actions/workflows/publish-pypi.yml +# 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/clear-street/studio-sdk-python/actions/workflows/publish-pypi.yml name: Publish PyPI on: workflow_dispatch: + release: + types: [published] + jobs: publish: name: publish diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index 5fe0928..1de0d34 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -7,7 +7,7 @@ jobs: release_doctor: name: release doctor runs-on: ubuntu-latest - if: github.repository == 'sachnk/studio-sdk-python' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') + if: github.repository == 'clear-street/studio-sdk-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 @@ -16,5 +16,4 @@ jobs: run: | bash ./bin/check-release-environment env: - STAINLESS_API_KEY: ${{ secrets.STAINLESS_API_KEY }} PYPI_TOKEN: ${{ secrets.STUDIO_SDK_PYPI_TOKEN || secrets.PYPI_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 818b51f..a0c9f8e 100644 --- a/CONTRIBUTING.md +++ b/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://git@github.com/sachnk/studio-sdk-python.git +pip install git+ssh://git@github.com/clear-street/studio-sdk-python.git ``` Alternatively, you can build from source and install the wheel file: @@ -117,7 +117,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/sachnk/studio-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/clear-street/studio-sdk-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 fd73293..0944013 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The REST API documentation can be found [on docs.studio-sdk.com](https://docs.st ```sh # install from the production repo -pip install git+ssh://git@github.com/sachnk/studio-sdk-python.git +pip install git+ssh://git@github.com/clear-street/studio-sdk-python.git ``` > [!NOTE] @@ -210,9 +210,9 @@ entity = response.parse() # get the object that `entities.retrieve()` would hav print(entity.entity_id) ``` -These methods return an [`APIResponse`](https://github.com/sachnk/studio-sdk-python/tree/main/src/studio_minus_sdk/_response.py) object. +These methods return an [`APIResponse`](https://github.com/clear-street/studio-sdk-python/tree/main/src/studio_minus_sdk/_response.py) object. -The async client returns an [`AsyncAPIResponse`](https://github.com/sachnk/studio-sdk-python/tree/main/src/studio_minus_sdk/_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/clear-street/studio-sdk-python/tree/main/src/studio_minus_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content. #### `.with_streaming_response` @@ -302,7 +302,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/sachnk/studio-sdk-python/issues) with questions, bugs, or suggestions. +We are keen for your feedback; please open an [issue](https://www.github.com/clear-street/studio-sdk-python/issues) with questions, bugs, or suggestions. ## Requirements diff --git a/bin/check-release-environment b/bin/check-release-environment index b021663..407904e 100644 --- a/bin/check-release-environment +++ b/bin/check-release-environment @@ -3,10 +3,6 @@ warnings=() errors=() -if [ -z "${STAINLESS_API_KEY}" ]; then - errors+=("The STAINLESS_API_KEY secret has not been set. Please contact Stainless for an API key & set it in your organization secrets on GitHub.") -fi - if [ -z "${PYPI_TOKEN}" ]; then warnings+=("The STUDIO_SDK_PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.") fi diff --git a/pyproject.toml b/pyproject.toml index 0905bc7..eec495a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,8 +39,8 @@ classifiers = [ [project.urls] -Homepage = "https://github.com/sachnk/studio-sdk-python" -Repository = "https://github.com/sachnk/studio-sdk-python" +Homepage = "https://github.com/clear-street/studio-sdk-python" +Repository = "https://github.com/clear-street/studio-sdk-python" @@ -124,7 +124,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/sachnk/studio-sdk-python/tree/main/\g<2>)' +replacement = '[\1](https://github.com/clear-street/studio-sdk-python/tree/main/\g<2>)' [tool.black] line-length = 120 From e1c139959000be1f7d171e08b8e3b024f61f64f9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 9 Jul 2024 16:57:44 +0000 Subject: [PATCH 2/3] feat(api): update via SDK Studio (#3) --- README.md | 2 +- SECURITY.md | 2 +- pyproject.toml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0944013..0ba2cab 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ It is generated with [Stainless](https://www.stainlessapi.com/). ## Documentation -The REST API documentation can be found [on docs.studio-sdk.com](https://docs.studio-sdk.com). The full API of this library can be found in [api.md](api.md). +The REST API documentation can be found [on docs.clearstreet.io](https://docs.clearstreet.io). The full API of this library can be found in [api.md](api.md). ## Installation diff --git a/SECURITY.md b/SECURITY.md index 8348dfd..955c2d6 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -20,7 +20,7 @@ or products provided by Studio SDK please follow the respective company's securi ### Studio SDK Terms and Policies -Please contact dev-feedback@studio-sdk.com for any questions or concerns regarding security of our services. +Please contact studiosupport@clearstreet.io for any questions or concerns regarding security of our services. --- diff --git a/pyproject.toml b/pyproject.toml index eec495a..7e98c5b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ description = "The official Python library for the studio-sdk API" dynamic = ["readme"] license = "Apache-2.0" authors = [ -{ name = "Studio SDK", email = "dev-feedback@studio-sdk.com" }, +{ name = "Studio SDK", email = "studiosupport@clearstreet.io" }, ] dependencies = [ "httpx>=0.23.0, <1", From 6d7cb84dd1b1f4191ad8c3fe07ffad4685b952c8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 9 Jul 2024 16:57:56 +0000 Subject: [PATCH 3/3] release: 0.1.0-alpha.1 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 16 ++++++++++++++++ pyproject.toml | 2 +- src/studio_minus_sdk/_version.py | 2 +- 4 files changed, 19 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..93f272c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog + +## 0.1.0-alpha.1 (2024-07-09) + +Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/clear-street/studio-sdk-python/compare/v0.0.1-alpha.0...v0.1.0-alpha.1) + +### Features + +* **api:** update via SDK Studio ([#3](https://github.com/clear-street/studio-sdk-python/issues/3)) ([e1c1399](https://github.com/clear-street/studio-sdk-python/commit/e1c139959000be1f7d171e08b8e3b024f61f64f9)) + + +### Chores + +* configure new SDK language ([7d853cb](https://github.com/clear-street/studio-sdk-python/commit/7d853cbb2a3451bea88c923e9a6aa0725340f51c)) +* go live ([#2](https://github.com/clear-street/studio-sdk-python/issues/2)) ([b8be4a5](https://github.com/clear-street/studio-sdk-python/commit/b8be4a51ff1a7ba9775448430f4e77b11aaaaa6c)) +* update SDK settings ([c6b7eeb](https://github.com/clear-street/studio-sdk-python/commit/c6b7eeb315a6111b886363b1983dacfab2e915bc)) diff --git a/pyproject.toml b/pyproject.toml index 7e98c5b..234a64b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "studio-sdk" -version = "0.0.1-alpha.0" +version = "0.1.0-alpha.1" description = "The official Python library for the studio-sdk API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/src/studio_minus_sdk/_version.py b/src/studio_minus_sdk/_version.py index f0f1bdd..ac0c13f 100644 --- a/src/studio_minus_sdk/_version.py +++ b/src/studio_minus_sdk/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "studio_minus_sdk" -__version__ = "0.0.1-alpha.0" # x-release-please-version +__version__ = "0.1.0-alpha.1" # x-release-please-version