Skip to content

release: 0.1.0-alpha.1 #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/publish-pypi.yml
Original file line number Diff line number Diff line change
@@ -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/gitpod-io/gitpod-sdk-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.GITPOD_PYPI_TOKEN || secrets.PYPI_TOKEN }}
21 changes: 21 additions & 0 deletions .github/workflows/release-doctor.yml
Original file line number Diff line number Diff line change
@@ -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 == 'gitpod-io/gitpod-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

- name: Check release environment
run: |
bash ./bin/check-release-environment
env:
PYPI_TOKEN: ${{ secrets.GITPOD_PYPI_TOKEN || secrets.PYPI_TOKEN }}
3 changes: 3 additions & 0 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
".": "0.1.0-alpha.1"
}
2 changes: 1 addition & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
configured_endpoints: 106
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-63491b1baa3dbc60caaec79becdece3854356b354909e4bb3f1ccaab80a6be20.yml
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-da4c36c6b1d973f481abb8eefdeb085d88eaf37eeaba30d276cb3daa405b6f0c.yml
103 changes: 103 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Changelog

## 0.1.0-alpha.1 (2025-02-11)

Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/gitpod-io/gitpod-sdk-python/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)

### Features

* **api:** add events streaming ([1d7a848](https://github.com/gitpod-io/gitpod-sdk-python/commit/1d7a848908ba3cb5c527bc6253c19e5a84a28b18))
* **api:** dedupe paginations ([75dc8c4](https://github.com/gitpod-io/gitpod-sdk-python/commit/75dc8c43b9ef8453cac3d9f18aafaa5deffca48f))
* **api:** fix pagination field names ([af22da1](https://github.com/gitpod-io/gitpod-sdk-python/commit/af22da11015915a96f68f74851abc7442fc4a0bf))
* **api:** manual updates ([0f00366](https://github.com/gitpod-io/gitpod-sdk-python/commit/0f00366da2833f31a9f298ac6c2ae980c1a6db99))
* **api:** manual updates ([4d19977](https://github.com/gitpod-io/gitpod-sdk-python/commit/4d199779647d6fafb2a1a26872b5a72c4b3378b6))
* **api:** pagination config ([c407e2e](https://github.com/gitpod-io/gitpod-sdk-python/commit/c407e2eaadda4d1ccbba6065235eac03a2332c48))
* **api:** properly produce empty request bodies ([#4](https://github.com/gitpod-io/gitpod-sdk-python/issues/4)) ([157b351](https://github.com/gitpod-io/gitpod-sdk-python/commit/157b35194ee33d9e83277e5b559a214c21e37531))
* **api:** try to fix updateenvironmentrequest ([#8](https://github.com/gitpod-io/gitpod-sdk-python/issues/8)) ([4d8e7c2](https://github.com/gitpod-io/gitpod-sdk-python/commit/4d8e7c207031edf11b3a3a9163f62b8e8d2f6576))
* **api:** update to latest changes ([#10](https://github.com/gitpod-io/gitpod-sdk-python/issues/10)) ([7822990](https://github.com/gitpod-io/gitpod-sdk-python/commit/7822990e687b35793e921b43aaa5cc73e101ae0f))
* **api:** update via SDK Studio ([3e66ecc](https://github.com/gitpod-io/gitpod-sdk-python/commit/3e66ecc1e5b3f7495b143f9fb31df85d24b871c6))
* **api:** update via SDK Studio ([66db733](https://github.com/gitpod-io/gitpod-sdk-python/commit/66db73366f6edaf7f0b21c1a88ec230b8650423d))
* **api:** update via SDK Studio ([d20eaba](https://github.com/gitpod-io/gitpod-sdk-python/commit/d20eaba8a2034c60b7957e74b1b060305102a520))
* **api:** update via SDK Studio ([b418dbe](https://github.com/gitpod-io/gitpod-sdk-python/commit/b418dbed6ce6c7e3a6eeee211f3391342cdc9d51))
* **api:** update via SDK Studio ([06c4b10](https://github.com/gitpod-io/gitpod-sdk-python/commit/06c4b10fff0b115550b0ab3a5fa106348d3868d4))
* **api:** update via SDK Studio ([5b25656](https://github.com/gitpod-io/gitpod-sdk-python/commit/5b2565694ed495e564f948078c02dd46efe8fadf))
* **api:** update via SDK Studio ([ea67c8c](https://github.com/gitpod-io/gitpod-sdk-python/commit/ea67c8c3e4ed067a049153a6807051bdf6f64cff))
* **api:** update via SDK Studio ([974fb63](https://github.com/gitpod-io/gitpod-sdk-python/commit/974fb635622cc790b134afa0e374e27951ab59b4))
* **api:** update via SDK Studio ([4e32701](https://github.com/gitpod-io/gitpod-sdk-python/commit/4e3270181d05a023bec2afc835dea83fcdcec3b2))
* **api:** update via SDK Studio ([f8ce60d](https://github.com/gitpod-io/gitpod-sdk-python/commit/f8ce60dbadb28a8d29184ac561f5c0608e23e5a0))
* **api:** update via SDK Studio ([87524c3](https://github.com/gitpod-io/gitpod-sdk-python/commit/87524c331c989fa4debc93bede3e16659f94ec62))
* **api:** update via SDK Studio ([2ac41b3](https://github.com/gitpod-io/gitpod-sdk-python/commit/2ac41b3c8889105bd7d5c9a052468646bd670252))
* **api:** update via SDK Studio ([7b2f2cf](https://github.com/gitpod-io/gitpod-sdk-python/commit/7b2f2cf872b573c4945ab7eb83e1011dcd082f06))
* **api:** update via SDK Studio ([c8930ae](https://github.com/gitpod-io/gitpod-sdk-python/commit/c8930ae28eb3d89dd32ca1db15d1bd4bd0423498))
* **api:** update via SDK Studio ([e42265e](https://github.com/gitpod-io/gitpod-sdk-python/commit/e42265e20f8fb254f4ea31f4f868de669dd31475))
* **api:** update via SDK Studio ([dd8ecd8](https://github.com/gitpod-io/gitpod-sdk-python/commit/dd8ecd84a27bb9c9701c269e05300a7d2d4e5708))
* **api:** update via SDK Studio ([8d5f640](https://github.com/gitpod-io/gitpod-sdk-python/commit/8d5f640dd221b455794a8cf40b2071af0467d3f5))
* **api:** update via SDK Studio ([e27af94](https://github.com/gitpod-io/gitpod-sdk-python/commit/e27af94de0c010b0970f3badad10ee35034dfe1d))
* **api:** update via SDK Studio ([48a5274](https://github.com/gitpod-io/gitpod-sdk-python/commit/48a5274bbc3678b4a0cc74679efa9884acb258df))
* **api:** update via SDK Studio ([2139387](https://github.com/gitpod-io/gitpod-sdk-python/commit/2139387ad0c36be18b31a0f3446c39c974637520))
* **api:** update via SDK Studio ([afa5045](https://github.com/gitpod-io/gitpod-sdk-python/commit/afa504592f2b73d450dfc7e9bd074fa22c23be7e))
* **client:** send `X-Stainless-Read-Timeout` header ([#6](https://github.com/gitpod-io/gitpod-sdk-python/issues/6)) ([682f05a](https://github.com/gitpod-io/gitpod-sdk-python/commit/682f05ae477692948c35e34666efa39110431020))
* **jsonl:** add .close() method ([#11](https://github.com/gitpod-io/gitpod-sdk-python/issues/11)) ([7d017fd](https://github.com/gitpod-io/gitpod-sdk-python/commit/7d017fdfa06fbc5297a5e58f9b110de5d8d7e7d0))
* pagination responses ([d009d64](https://github.com/gitpod-io/gitpod-sdk-python/commit/d009d64229f53e4f271799d273bbbae26fb3520b))


### Bug Fixes

* **api:** better support union schemas with common properties ([ad416b2](https://github.com/gitpod-io/gitpod-sdk-python/commit/ad416b216575ab7c015ab984dd94a72b240ad467))
* **client:** compat with new httpx 0.28.0 release ([abc0621](https://github.com/gitpod-io/gitpod-sdk-python/commit/abc0621222e659f182967b3ca147280f244e1fc4))
* **client:** only call .close() when needed ([bbb6747](https://github.com/gitpod-io/gitpod-sdk-python/commit/bbb6747ad4d09e9066cda67947fea40937d89bd2))
* correctly handle deserialising `cls` fields ([df55d8a](https://github.com/gitpod-io/gitpod-sdk-python/commit/df55d8a1decd0514c24033b9f2615616a1ae2292))
* **jsonl:** lower chunk size ([#12](https://github.com/gitpod-io/gitpod-sdk-python/issues/12)) ([f07eb3f](https://github.com/gitpod-io/gitpod-sdk-python/commit/f07eb3fee38d93d8ac2955f2846f8dd6ca74a5cc))
* pagination example ([8ddfb41](https://github.com/gitpod-io/gitpod-sdk-python/commit/8ddfb41ab1b872e2d8535194801826e88e7dee08))
* pagination response ([ba50863](https://github.com/gitpod-io/gitpod-sdk-python/commit/ba50863a1b9e11dcaafa657475081147f2fefd23))
* **tests:** disable mock tests ([#5](https://github.com/gitpod-io/gitpod-sdk-python/issues/5)) ([96537af](https://github.com/gitpod-io/gitpod-sdk-python/commit/96537af8e3e02ea3b043d5e1433df56344bfdea8))
* **tests:** disable test mocks ([#3](https://github.com/gitpod-io/gitpod-sdk-python/issues/3)) ([9a6b2e8](https://github.com/gitpod-io/gitpod-sdk-python/commit/9a6b2e8c7693b6de6cc15efcd6ea9594f90e291f))
* **tests:** make test_get_platform less flaky ([51968d4](https://github.com/gitpod-io/gitpod-sdk-python/commit/51968d4b351b54b5b402d8a77b37249205fe3681))


### Chores

* add missing isclass check ([ff7cbaa](https://github.com/gitpod-io/gitpod-sdk-python/commit/ff7cbaa4807baf6951a6317880ab894949129e85))
* go live ([#1](https://github.com/gitpod-io/gitpod-sdk-python/issues/1)) ([c9a1a30](https://github.com/gitpod-io/gitpod-sdk-python/commit/c9a1a30529fdd39494b65ddfaa724c255fa52888))
* go live ([#14](https://github.com/gitpod-io/gitpod-sdk-python/issues/14)) ([566fc35](https://github.com/gitpod-io/gitpod-sdk-python/commit/566fc3518fc2448b8d98b5f1f24f668c91343a7e))
* **internal:** avoid pytest-asyncio deprecation warning ([3c00c53](https://github.com/gitpod-io/gitpod-sdk-python/commit/3c00c53a00ff67157829da89bbbaceae142a411e))
* **internal:** bump httpx dependency ([e160bd9](https://github.com/gitpod-io/gitpod-sdk-python/commit/e160bd9a691017994b8704cca5eaaef0d0344940))
* **internal:** bump pydantic dependency ([5ce555b](https://github.com/gitpod-io/gitpod-sdk-python/commit/5ce555ba5ccdfa37a62c891e46a1758e1445369c))
* **internal:** bump pyright ([aba3b34](https://github.com/gitpod-io/gitpod-sdk-python/commit/aba3b34b382753596f0e3bbc211221b307d2d32c))
* **internal:** change default timeout to an int ([6430f4c](https://github.com/gitpod-io/gitpod-sdk-python/commit/6430f4cde5fb665c32501880ff06127b348e8b31))
* **internal:** codegen related update ([ec5eb7e](https://github.com/gitpod-io/gitpod-sdk-python/commit/ec5eb7e1ab7ce34c1f359300fdc1354e1d5cf549))
* **internal:** codegen related update ([497ae18](https://github.com/gitpod-io/gitpod-sdk-python/commit/497ae18d5624499a7c907f4689a8879b7c1d40b1))
* **internal:** codegen related update ([c9288d5](https://github.com/gitpod-io/gitpod-sdk-python/commit/c9288d535936274a7927b2bb2bf7e424e5b1e8b4))
* **internal:** codegen related update ([cb8475b](https://github.com/gitpod-io/gitpod-sdk-python/commit/cb8475b8084ade988b2861b636a432d45fb3b2ff))
* **internal:** codegen related update ([26b774b](https://github.com/gitpod-io/gitpod-sdk-python/commit/26b774b422be3b8f51ab25facff1c75c89257991))
* **internal:** codegen related update ([0f3b621](https://github.com/gitpod-io/gitpod-sdk-python/commit/0f3b6216e5c5fe1155fa8ae28fb8a81c65421267))
* **internal:** codegen related update ([0dab9d3](https://github.com/gitpod-io/gitpod-sdk-python/commit/0dab9d38924656bf9c2132a320d1233bc61e696a))
* **internal:** codegen related update ([838ff11](https://github.com/gitpod-io/gitpod-sdk-python/commit/838ff11b1d62ddc7148953e73262a35e1ec575ec))
* **internal:** codegen related update ([fafa29d](https://github.com/gitpod-io/gitpod-sdk-python/commit/fafa29d268068e422e5b774eacdd2faedbe32f39))
* **internal:** codegen related update ([80c8bbf](https://github.com/gitpod-io/gitpod-sdk-python/commit/80c8bbfa9f757e97878d336cd9cd7babe5d52d6b))
* **internal:** codegen related update ([36c6d5e](https://github.com/gitpod-io/gitpod-sdk-python/commit/36c6d5eb17f40adb63a29f22d89afa8eca9c0677))
* **internal:** exclude mypy from running on tests ([cae2176](https://github.com/gitpod-io/gitpod-sdk-python/commit/cae2176e0a99d1094f797fb49baab2435c04d5f6))
* **internal:** fix compat model_dump method when warnings are passed ([ee87f96](https://github.com/gitpod-io/gitpod-sdk-python/commit/ee87f963bab5e9ac07b3a9fb4c40f46ca3a07613))
* **internal:** fix some typos ([c0f7e58](https://github.com/gitpod-io/gitpod-sdk-python/commit/c0f7e58307c3602499e72354aee6d2ada1e15528))
* **internal:** fix type traversing dictionary params ([#7](https://github.com/gitpod-io/gitpod-sdk-python/issues/7)) ([86cea9d](https://github.com/gitpod-io/gitpod-sdk-python/commit/86cea9dcf4c25a5787023bb9ab378ac1b90e9b7c))
* **internal:** minor formatting changes ([2273048](https://github.com/gitpod-io/gitpod-sdk-python/commit/2273048b7dbc282f31edf563d56ff8dd223969d8))
* **internal:** minor type handling changes ([#9](https://github.com/gitpod-io/gitpod-sdk-python/issues/9)) ([c10beb0](https://github.com/gitpod-io/gitpod-sdk-python/commit/c10beb0e2369438df39099e48fe7f0a0d4bcace5))
* **internal:** remove some duplicated imports ([8e6cc74](https://github.com/gitpod-io/gitpod-sdk-python/commit/8e6cc74d2e16297d05cd9cc233e4d79fdff64930))
* **internal:** update examples ([d652f4e](https://github.com/gitpod-io/gitpod-sdk-python/commit/d652f4e1ab70a731eff04beb3ff0f7c471dbcacf))
* **internal:** updated imports ([d31547b](https://github.com/gitpod-io/gitpod-sdk-python/commit/d31547b97db1baea0383ecb8a86e65270a093b77))
* make the `Omit` type public ([cf43176](https://github.com/gitpod-io/gitpod-sdk-python/commit/cf4317618f0cc177f812781d62bd454afa279f45))
* rebuild project due to codegen change ([4c930a5](https://github.com/gitpod-io/gitpod-sdk-python/commit/4c930a5227bbec3f5a3d378ababf01ae8d4cedb3))
* rebuild project due to codegen change ([b7129db](https://github.com/gitpod-io/gitpod-sdk-python/commit/b7129db829b29adc2fbcf0eebdfc9f97e80d74c6))
* rebuild project due to codegen change ([56f37cb](https://github.com/gitpod-io/gitpod-sdk-python/commit/56f37cb299889d38a458cacc659c21df8bf14fbe))
* rebuild project due to codegen change ([710a64b](https://github.com/gitpod-io/gitpod-sdk-python/commit/710a64bcff5107c7180c9c994594c30a65e182cb))
* remove now unused `cached-property` dep ([b66de02](https://github.com/gitpod-io/gitpod-sdk-python/commit/b66de02aeb1dfe216c3c6f4687db973de79f03d2))
* security config ([3c91d8f](https://github.com/gitpod-io/gitpod-sdk-python/commit/3c91d8f00626733cdfb925c0382b994f287b8c33))


### Documentation

* add info log level to readme ([aebe445](https://github.com/gitpod-io/gitpod-sdk-python/commit/aebe445be3e15f9773dad03ee9b3f565f3c7273b))
* fix typos ([35edab0](https://github.com/gitpod-io/gitpod-sdk-python/commit/35edab0b4da50551371b866f4a24a5c520fa9264))
* **raw responses:** fix duplicate `the` ([5d59373](https://github.com/gitpod-io/gitpod-sdk-python/commit/5d5937373485b2a0293d9ebd0ca949d9ed8da26f))
* **readme:** example snippet for client context manager ([b8180b3](https://github.com/gitpod-io/gitpod-sdk-python/commit/b8180b3266fe57a68e3e72af355bb7cc898b8bf2))
* **readme:** fix http client proxies example ([079665c](https://github.com/gitpod-io/gitpod-sdk-python/commit/079665c9ce58df2e2f7c77cb6b610fdb0dc62c43))
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://[email protected]/stainless-sdks/gitpod-python.git
$ pip install git+ssh://[email protected]/gitpod-io/gitpod-sdk-python.git
```

Alternatively, you can build from source and install the wheel file:
Expand Down Expand Up @@ -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/gitpod-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/gitpod-io/gitpod-sdk-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.

### Publish manually

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ The REST API documentation can be found on [docs.gitpod.com](https://docs.gitpod
## Installation

```sh
# install from this staging repo
pip install git+ssh://[email protected]/stainless-sdks/gitpod-python.git
# install from the production repo
pip install git+ssh://[email protected]/gitpod-io/gitpod-sdk-python.git
```

> [!NOTE]
Expand Down Expand Up @@ -269,9 +269,9 @@ runner = response.parse() # get the object that `runners.create()` would have r
print(runner.access_token)
```

These methods return an [`APIResponse`](https://github.com/stainless-sdks/gitpod-python/tree/main/src/gitpod/_response.py) object.
These methods return an [`APIResponse`](https://github.com/gitpod-io/gitpod-sdk-python/tree/main/src/gitpod/_response.py) object.

The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/gitpod-python/tree/main/src/gitpod/_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/gitpod-io/gitpod-sdk-python/tree/main/src/gitpod/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.

#### `.with_streaming_response`

Expand Down Expand Up @@ -375,7 +375,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/gitpod-python/issues) with questions, bugs, or suggestions.
We are keen for your feedback; please open an [issue](https://www.github.com/gitpod-io/gitpod-sdk-python/issues) with questions, bugs, or suggestions.

### Determining the installed version

Expand Down
Loading
Loading