Skip to content

chore: go live #14

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 1 commit 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
2 changes: 1 addition & 1 deletion .github/workflows/publish-pypi.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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/flex-sdk-python/actions/workflows/publish-pypi.yml
# 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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-doctor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
release_doctor:
name: release doctor
runs-on: ubuntu-latest
if: github.repository == 'gitpod-io/flex-sdk-python' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
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
Expand Down
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]/gitpod-io/flex-sdk-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/gitpod-io/flex-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/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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The REST API documentation can be found on [docs.gitpod.com](https://docs.gitpod

```sh
# install from the production repo
pip install git+ssh://[email protected]/gitpod-io/flex-sdk-python.git
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/gitpod-io/flex-sdk-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/gitpod-io/flex-sdk-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/gitpod-io/flex-sdk-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
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ classifiers = [
]

[project.urls]
Homepage = "https://github.com/gitpod-io/flex-sdk-python"
Repository = "https://github.com/gitpod-io/flex-sdk-python"
Homepage = "https://github.com/gitpod-io/gitpod-sdk-python"
Repository = "https://github.com/gitpod-io/gitpod-sdk-python"



Expand Down Expand Up @@ -122,7 +122,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/gitpod-io/flex-sdk-python/tree/main/\g<2>)'
replacement = '[\1](https://github.com/gitpod-io/gitpod-sdk-python/tree/main/\g<2>)'

[tool.pytest.ini_options]
testpaths = ["tests"]
Expand Down
8 changes: 4 additions & 4 deletions src/gitpod/resources/accounts.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def with_raw_response(self) -> AccountsResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AccountsResourceWithRawResponse(self)

Expand All @@ -50,7 +50,7 @@ def with_streaming_response(self) -> AccountsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AccountsResourceWithStreamingResponse(self)

Expand Down Expand Up @@ -229,7 +229,7 @@ def with_raw_response(self) -> AsyncAccountsResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AsyncAccountsResourceWithRawResponse(self)

Expand All @@ -238,7 +238,7 @@ def with_streaming_response(self) -> AsyncAccountsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AsyncAccountsResourceWithStreamingResponse(self)

Expand Down
8 changes: 4 additions & 4 deletions src/gitpod/resources/editors.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def with_raw_response(self) -> EditorsResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return EditorsResourceWithRawResponse(self)

Expand All @@ -43,7 +43,7 @@ def with_streaming_response(self) -> EditorsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return EditorsResourceWithStreamingResponse(self)

Expand Down Expand Up @@ -184,7 +184,7 @@ def with_raw_response(self) -> AsyncEditorsResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AsyncEditorsResourceWithRawResponse(self)

Expand All @@ -193,7 +193,7 @@ def with_streaming_response(self) -> AsyncEditorsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AsyncEditorsResourceWithStreamingResponse(self)

Expand Down
8 changes: 4 additions & 4 deletions src/gitpod/resources/environments/automations/automations.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def with_raw_response(self) -> AutomationsResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AutomationsResourceWithRawResponse(self)

Expand All @@ -65,7 +65,7 @@ def with_streaming_response(self) -> AutomationsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AutomationsResourceWithStreamingResponse(self)

Expand Down Expand Up @@ -129,7 +129,7 @@ def with_raw_response(self) -> AsyncAutomationsResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AsyncAutomationsResourceWithRawResponse(self)

Expand All @@ -138,7 +138,7 @@ def with_streaming_response(self) -> AsyncAutomationsResourceWithStreamingRespon
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AsyncAutomationsResourceWithStreamingResponse(self)

Expand Down
8 changes: 4 additions & 4 deletions src/gitpod/resources/environments/automations/services.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def with_raw_response(self) -> ServicesResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return ServicesResourceWithRawResponse(self)

Expand All @@ -53,7 +53,7 @@ def with_streaming_response(self) -> ServicesResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return ServicesResourceWithStreamingResponse(self)

Expand Down Expand Up @@ -357,7 +357,7 @@ def with_raw_response(self) -> AsyncServicesResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AsyncServicesResourceWithRawResponse(self)

Expand All @@ -366,7 +366,7 @@ def with_streaming_response(self) -> AsyncServicesResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AsyncServicesResourceWithStreamingResponse(self)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def with_raw_response(self) -> ExecutionsResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return ExecutionsResourceWithRawResponse(self)

Expand All @@ -46,7 +46,7 @@ def with_streaming_response(self) -> ExecutionsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return ExecutionsResourceWithStreamingResponse(self)

Expand Down Expand Up @@ -179,7 +179,7 @@ def with_raw_response(self) -> AsyncExecutionsResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AsyncExecutionsResourceWithRawResponse(self)

Expand All @@ -188,7 +188,7 @@ def with_streaming_response(self) -> AsyncExecutionsResourceWithStreamingRespons
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AsyncExecutionsResourceWithStreamingResponse(self)

Expand Down
8 changes: 4 additions & 4 deletions src/gitpod/resources/environments/automations/tasks/tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def with_raw_response(self) -> TasksResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return TasksResourceWithRawResponse(self)

Expand All @@ -67,7 +67,7 @@ def with_streaming_response(self) -> TasksResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return TasksResourceWithStreamingResponse(self)

Expand Down Expand Up @@ -326,7 +326,7 @@ def with_raw_response(self) -> AsyncTasksResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AsyncTasksResourceWithRawResponse(self)

Expand All @@ -335,7 +335,7 @@ def with_streaming_response(self) -> AsyncTasksResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AsyncTasksResourceWithStreamingResponse(self)

Expand Down
8 changes: 4 additions & 4 deletions src/gitpod/resources/environments/classes.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def with_raw_response(self) -> ClassesResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return ClassesResourceWithRawResponse(self)

Expand All @@ -38,7 +38,7 @@ def with_streaming_response(self) -> ClassesResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return ClassesResourceWithStreamingResponse(self)

Expand Down Expand Up @@ -107,7 +107,7 @@ def with_raw_response(self) -> AsyncClassesResourceWithRawResponse:
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/gitpod-io/flex-sdk-python#accessing-raw-response-data-eg-headers
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AsyncClassesResourceWithRawResponse(self)

Expand All @@ -116,7 +116,7 @@ def with_streaming_response(self) -> AsyncClassesResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/gitpod-io/flex-sdk-python#with_streaming_response
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AsyncClassesResourceWithStreamingResponse(self)

Expand Down
Loading