Repository files navigation

The Gitpod Python library provides convenient access to the Gitpod REST API from any Python 3.8+application. The library includes type definitions for all request params and response fields,and offers both synchronous and asynchronous clients powered byhttpx.

It is generated withStainless.

The REST API documentation can be found ondocs.gitpod.io. The full API of this library can be found inapi.md.

# install from PyPIpip install gitpod-sdk

The full API of this library can be found inapi.md.

importosfromgitpodimportGitpodclient=Gitpod(bearer_token=os.environ.get("GITPOD_API_KEY"),# This is the default and can be omitted)response=client.identity.get_authenticated_identity()print(response.organization_id)

While you can provide abearer_token keyword argument,we recommend usingpython-dotenvto addGITPOD_API_KEY="My Bearer Token" to your.env fileso that your Bearer Token is not stored in source control.

Simply importAsyncGitpod instead ofGitpod and useawait with each API call:

importosimportasynciofromgitpodimportAsyncGitpodclient=AsyncGitpod(bearer_token=os.environ.get("GITPOD_API_KEY"),# This is the default and can be omitted)asyncdefmain()->None:response=awaitclient.identity.get_authenticated_identity()print(response.organization_id)asyncio.run(main())

Functionality between the synchronous and asynchronous clients is otherwise identical.

Nested request parameters areTypedDicts. Responses arePydantic models which also provide helper methods for things like:

• Serializing back into JSON,model.to_json()
• Converting to a dictionary,model.to_dict()

Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, setpython.analysis.typeCheckingMode tobasic.

List methods in the Gitpod API are paginated.

This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:

fromgitpodimportGitpodclient=Gitpod()all_environments= []# Automatically fetches more pages as needed.forenvironmentinclient.environments.list():# Do something with environment hereall_environments.append(environment)print(all_environments)

Or, asynchronously:

importasynciofromgitpodimportAsyncGitpodclient=AsyncGitpod()asyncdefmain()->None:all_environments= []# Iterate through items across all pages, issuing requests as needed.asyncforenvironmentinclient.environments.list():all_environments.append(environment)print(all_environments)asyncio.run(main())

Alternatively, you can use the.has_next_page(),.next_page_info(), or.get_next_page() methods for more granular control working with pages:

first_page=awaitclient.environments.list()iffirst_page.has_next_page():print(f"will fetch next page using these details:{first_page.next_page_info()}")next_page=awaitfirst_page.get_next_page()print(f"number of items we just fetched:{len(next_page.environments)}")# Remove `await` for non-async usage.

Or just work directly with the returned data:

first_page=awaitclient.environments.list()print(f"next page cursor:{first_page.pagination.next_token}")# => "next page cursor: ..."forenvironmentinfirst_page.environments:print(environment.id)# Remove `await` for non-async usage.

Nested parameters are dictionaries, typed usingTypedDict, for example:

fromgitpodimportGitpodclient=Gitpod()page=client.accounts.list_login_providers(filter={},)print(page.login_providers)

When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass ofgitpod.APIConnectionError is raised.

When the API returns a non-success status code (that is, 4xx or 5xxresponse), a subclass ofgitpod.APIStatusError is raised, containingstatus_code andresponse properties.

All errors inherit fromgitpod.APIError.

importgitpodfromgitpodimportGitpodclient=Gitpod()try:client.identity.get_authenticated_identity()exceptgitpod.APIConnectionErrorase:print("The server could not be reached")print(e.__cause__)# an underlying Exception, likely raised within httpx.exceptgitpod.RateLimitErrorase:print("A 429 status code was received; we should back off a bit.")exceptgitpod.APIStatusErrorase:print("Another non-200-range status code was received")print(e.status_code)print(e.response)

Error codes are as follows:

Certain errors are automatically retried 2 times by default, with a short exponential backoff.Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,429 Rate Limit, and >=500 Internal errors are all retried by default.

You can use themax_retries option to configure or disable retry settings:

fromgitpodimportGitpod# Configure the default for all requests:client=Gitpod(# default is 2max_retries=0,)# Or, configure per-request:client.with_options(max_retries=5).identity.get_authenticated_identity()

By default requests time out after 1 minute. You can configure this with atimeout option,which accepts a float or anhttpx.Timeout object:

fromgitpodimportGitpod# Configure the default for all requests:client=Gitpod(# 20 seconds (default is 1 minute)timeout=20.0,)# More granular control:client=Gitpod(timeout=httpx.Timeout(60.0,read=5.0,write=10.0,connect=2.0),)# Override per-request:client.with_options(timeout=5.0).identity.get_authenticated_identity()

On timeout, anAPITimeoutError is thrown.

Note that requests that time out areretried twice by default.

We use the standard librarylogging module.

You can enable logging by setting the environment variableGITPOD_LOG toinfo.

$export GITPOD_LOG=info

Or todebug for more verbose logging.

In an API response, a field may be explicitlynull, or missing entirely; in either case, its value isNone in this library. You can differentiate the two cases with.model_fields_set:

ifresponse.my_fieldisNone:if'my_field'notinresponse.model_fields_set:print('Got json like {}, without a "my_field" key present at all.')else:print('Got json like {"my_field": null}.')

The "raw" Response object can be accessed by prefixing.with_raw_response. to any HTTP method call, e.g.,

fromgitpodimportGitpodclient=Gitpod()response=client.identity.with_raw_response.get_authenticated_identity()print(response.headers.get('X-My-Header'))identity=response.parse()# get the object that `identity.get_authenticated_identity()` would have returnedprint(identity.organization_id)

These methods return anAPIResponse object.

The async client returns anAsyncAPIResponse with the same structure, the only difference beingawaitable methods for reading the response content.

The above interface eagerly reads the full response body when you make the request, which may not always be what you want.

To stream the response body, use.with_streaming_response instead, which requires a context manager and only reads the response body once you call.read(),.text(),.json(),.iter_bytes(),.iter_text(),.iter_lines() or.parse(). In the async client, these are async methods.

withclient.identity.with_streaming_response.get_authenticated_identity()asresponse:print(response.headers.get("X-My-Header"))forlineinresponse.iter_lines():print(line)

The context manager is required so that the response will reliably be closed.

This library is typed for convenient access to the documented API.

If you need to access undocumented endpoints, params, or response properties, the library can still be used.

To make requests to undocumented endpoints, you can make requests usingclient.get,client.post, and otherhttp verbs. Options on the client will be respected (such as retries) when making this request.

importhttpxresponse=client.post("/foo",cast_to=httpx.Response,body={"my_param":True},)print(response.headers.get("x-foo"))

If you want to explicitly send an extra param, you can do so with theextra_query,extra_body, andextra_headers requestoptions.

To access undocumented response properties, you can access the extra fields likeresponse.unknown_prop. Youcan also get all the extra fields on the Pydantic model as a dict withresponse.model_extra.

You can directly override thehttpx client to customize it for your use case, including:

• Support forproxies
• Customtransports
• Additionaladvanced functionality

importhttpxfromgitpodimportGitpod,DefaultHttpxClientclient=Gitpod(# Or use the `GITPOD_BASE_URL` env varbase_url="http://my.test.server.example.com:8083",http_client=DefaultHttpxClient(proxy="http://my.test.proxy.example.com",transport=httpx.HTTPTransport(local_address="0.0.0.0"),    ),)

You can also customize the client on a per-request basis by usingwith_options():

client.with_options(http_client=DefaultHttpxClient(...))

By default the library closes underlying HTTP connections whenever the client isgarbage collected. You can manually close the client using the.close() method if desired, or with a context manager that closes when exiting.

fromgitpodimportGitpodwithGitpod()asclient:# make requests here  ...# HTTP client is now closed

This package generally followsSemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes that only affect static types, without breaking runtime behavior.
2. Changes to library internals which are technically public but not intended or documented for external use.(Please open a GitHub issue to let us know if you are relying on such internals.)
3. Changes that we do not expect to impact the vast majority of users in practice.

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 anissue with questions, bugs, or suggestions.

If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.

You can determine the version that is being used at runtime with:

importgitpodprint(gitpod.__version__)

Python 3.8 or higher.

Seethe contributing documentation.