diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml new file mode 100644 index 0000000..cadbc75 --- /dev/null +++ b/.github/workflows/publish-pypi.yml @@ -0,0 +1,28 @@ +# 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/brand-dot-dev/context-python-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@v6 + + - name: Install uv + uses: astral-sh/setup-uv@v5 + with: + version: '0.9.13' + + - name: Publish to PyPI + run: | + bash ./bin/publish-pypi + env: + PYPI_TOKEN: ${{ secrets.CONTEXT_DEV_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..ef3b60a --- /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 == 'brand-dot-dev/context-python-sdk' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') + + steps: + - uses: actions/checkout@v6 + + - name: Check release environment + run: | + bash ./bin/check-release-environment + env: + PYPI_TOKEN: ${{ secrets.CONTEXT_DEV_PYPI_TOKEN || secrets.PYPI_TOKEN }} diff --git a/.release-please-manifest.json b/.release-please-manifest.json new file mode 100644 index 0000000..c7159c1 --- /dev/null +++ b/.release-please-manifest.json @@ -0,0 +1,3 @@ +{ + ".": "0.0.2" +} \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 5793132..cd9a6aa 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev%2Fcontext.dev-a69e6793d72c7f91069972b64ff2e35b4ddfa62cd35d6451b7d63f95d5957951.yml openapi_spec_hash: 8a77eef26c37dc2b63110169f0eef1f6 -config_hash: ffaf6d9c3318f968f81f096226f074c2 +config_hash: 9eebba57068a04ff872a84fd34214b9b diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e544400 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + +## 0.0.2 (2026-03-14) + +Full Changelog: [v0.0.1...v0.0.2](https://github.com/brand-dot-dev/context-python-sdk/compare/v0.0.1...v0.0.2) + +### Chores + +* configure new SDK language ([0277c2c](https://github.com/brand-dot-dev/context-python-sdk/commit/0277c2c3a9c03e58f50a2628c133612140dd6f73)) +* update SDK settings ([154e20a](https://github.com/brand-dot-dev/context-python-sdk/commit/154e20a04eed818849ddcada3f11d97b918abf46)) +* update SDK settings ([212e987](https://github.com/brand-dot-dev/context-python-sdk/commit/212e987d1d5d6dbbf0bc5f5a1a6eab6a69e67775)) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e48fc34..27fbe67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,7 +62,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/context.dev-python.git +$ pip install git+ssh://git@github.com/brand-dot-dev/context-python-sdk.git ``` Alternatively, you can build from source and install the wheel file: @@ -113,7 +113,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/context.dev-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/brand-dot-dev/context-python-sdk/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 a4bcf68..b218d59 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,10 @@ The REST API documentation can be found on [docs.context.dev](https://docs.conte ## Installation ```sh -# install from this staging repo -pip install git+ssh://git@github.com/stainless-sdks/context.dev-python.git +# install from PyPI +pip install context.dev ``` -> [!NOTE] -> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install context.dev` - ## Usage The full API of this library can be found in [api.md](api.md). @@ -88,8 +85,8 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv You can enable this by installing `aiohttp`: ```sh -# install from this staging repo -pip install 'context.dev[aiohttp] @ git+ssh://git@github.com/stainless-sdks/context.dev-python.git' +# install from PyPI +pip install context.dev[aiohttp] ``` Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`: @@ -286,9 +283,9 @@ brand = response.parse() # get the object that `brand.retrieve()` would have re print(brand.brand) ``` -These methods return an [`APIResponse`](https://github.com/stainless-sdks/context.dev-python/tree/main/src/context/dev/_response.py) object. +These methods return an [`APIResponse`](https://github.com/brand-dot-dev/context-python-sdk/tree/main/src/context/dev/_response.py) object. -The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/context.dev-python/tree/main/src/context/dev/_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/brand-dot-dev/context-python-sdk/tree/main/src/context/dev/_response.py) with the same structure, the only difference being `await`able methods for reading the response content. #### `.with_streaming_response` @@ -394,7 +391,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/context.dev-python/issues) with questions, bugs, or suggestions. +We are keen for your feedback; please open an [issue](https://www.github.com/brand-dot-dev/context-python-sdk/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..b845b0f --- /dev/null +++ b/bin/check-release-environment @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +errors=() + +if [ -z "${PYPI_TOKEN}" ]; then + errors+=("The 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 219855b..11c7d3a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "context.dev" -version = "0.0.1" +version = "0.0.2" description = "The official Python library for the context.dev API" dynamic = ["readme"] license = "Apache-2.0" @@ -37,8 +37,8 @@ classifiers = [ ] [project.urls] -Homepage = "https://github.com/stainless-sdks/context.dev-python" -Repository = "https://github.com/stainless-sdks/context.dev-python" +Homepage = "https://github.com/brand-dot-dev/context-python-sdk" +Repository = "https://github.com/brand-dot-dev/context-python-sdk" [project.optional-dependencies] aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.9"] @@ -112,7 +112,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/context.dev-python/tree/main/\g<2>)' +replacement = '[\1](https://github.com/brand-dot-dev/context-python-sdk/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..c0bd40d --- /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/context/dev/_version.py" + ] +} \ No newline at end of file diff --git a/src/context/dev/_version.py b/src/context/dev/_version.py index 03ca544..ae7e32b 100644 --- a/src/context/dev/_version.py +++ b/src/context/dev/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "context.dev" -__version__ = "0.0.1" +__version__ = "0.0.2" # x-release-please-version diff --git a/src/context/dev/resources/brand.py b/src/context/dev/resources/brand.py index 0014ec1..537604d 100644 --- a/src/context/dev/resources/brand.py +++ b/src/context/dev/resources/brand.py @@ -71,7 +71,7 @@ def with_raw_response(self) -> BrandResourceWithRawResponse: 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/context.dev-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/brand-dot-dev/context-python-sdk#accessing-raw-response-data-eg-headers """ return BrandResourceWithRawResponse(self) @@ -80,7 +80,7 @@ def with_streaming_response(self) -> BrandResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/context.dev-python#with_streaming_response + For more information, see https://www.github.com/brand-dot-dev/context-python-sdk#with_streaming_response """ return BrandResourceWithStreamingResponse(self) @@ -1902,7 +1902,7 @@ def with_raw_response(self) -> AsyncBrandResourceWithRawResponse: 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/context.dev-python#accessing-raw-response-data-eg-headers + For more information, see https://www.github.com/brand-dot-dev/context-python-sdk#accessing-raw-response-data-eg-headers """ return AsyncBrandResourceWithRawResponse(self) @@ -1911,7 +1911,7 @@ def with_streaming_response(self) -> AsyncBrandResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. - For more information, see https://www.github.com/stainless-sdks/context.dev-python#with_streaming_response + For more information, see https://www.github.com/brand-dot-dev/context-python-sdk#with_streaming_response """ return AsyncBrandResourceWithStreamingResponse(self)