| Name | runloop-api-client JSON |
| Version |
0.9.0
JSON |
| download |
| home_page | None |
| Summary | The official Python library for the runloop API |
| upload_time | 2024-11-07 19:29:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Runloop Python API library
[](https://pypi.org/project/runloop_api_client/)
The Runloop Python library provides convenient access to the Runloop 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 by [httpx](https://github.com/encode/httpx).
It is generated with [Stainless](https://www.stainlessapi.com/).
## Documentation
The REST API documentation can be found on [runloop.ai](https://runloop.ai). The full API of this library can be found in [api.md](https://github.com/runloopai/api-client-python/tree/main/api.md).
## Installation
```sh
# install from PyPI
pip install runloop_api_client
```
## Usage
The full API of this library can be found in [api.md](https://github.com/runloopai/api-client-python/tree/main/api.md).
```python
import os
from runloop_api_client import Runloop
client = Runloop(
# This is the default and can be omitted
bearer_token=os.environ.get("RUNLOOP_API_KEY"),
)
devbox_view = client.devboxes.create()
print(devbox_view.id)
```
While you can provide a `bearer_token` keyword argument,
we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
to add `RUNLOOP_API_KEY="My Bearer Token"` to your `.env` file
so that your Bearer Token is not stored in source control.
## Async usage
Simply import `AsyncRunloop` instead of `Runloop` and use `await` with each API call:
```python
import os
import asyncio
from runloop_api_client import AsyncRunloop
client = AsyncRunloop(
# This is the default and can be omitted
bearer_token=os.environ.get("RUNLOOP_API_KEY"),
)
async def main() -> None:
devbox_view = await client.devboxes.create()
print(devbox_view.id)
asyncio.run(main())
```
Functionality between the synchronous and asynchronous clients is otherwise identical.
## Using types
Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) 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, set `python.analysis.typeCheckingMode` to `basic`.
## Handling errors
When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `runloop_api_client.APIConnectionError` is raised.
When the API returns a non-success status code (that is, 4xx or 5xx
response), a subclass of `runloop_api_client.APIStatusError` is raised, containing `status_code` and `response` properties.
All errors inherit from `runloop_api_client.APIError`.
```python
import runloop_api_client
from runloop_api_client import Runloop
client = Runloop()
try:
client.devboxes.create()
except runloop_api_client.APIConnectionError as e:
print("The server could not be reached")
print(e.__cause__) # an underlying Exception, likely raised within httpx.
except runloop_api_client.RateLimitError as e:
print("A 429 status code was received; we should back off a bit.")
except runloop_api_client.APIStatusError as e:
print("Another non-200-range status code was received")
print(e.status_code)
print(e.response)
```
Error codes are as followed:
| Status Code | Error Type |
| ----------- | -------------------------- |
| 400 | `BadRequestError` |
| 401 | `AuthenticationError` |
| 403 | `PermissionDeniedError` |
| 404 | `NotFoundError` |
| 422 | `UnprocessableEntityError` |
| 429 | `RateLimitError` |
| >=500 | `InternalServerError` |
| N/A | `APIConnectionError` |
### Retries
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 the `max_retries` option to configure or disable retry settings:
```python
from runloop_api_client import Runloop
# Configure the default for all requests:
client = Runloop(
# default is 2
max_retries=0,
)
# Or, configure per-request:
client.with_options(max_retries=5).devboxes.create()
```
### Timeouts
By default requests time out after 1 minute. You can configure this with a `timeout` option,
which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
```python
from runloop_api_client import Runloop
# Configure the default for all requests:
client = Runloop(
# 20 seconds (default is 1 minute)
timeout=20.0,
)
# More granular control:
client = Runloop(
timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)
# Override per-request:
client.with_options(timeout=5.0).devboxes.create()
```
On timeout, an `APITimeoutError` is thrown.
Note that requests that time out are [retried twice by default](https://github.com/runloopai/api-client-python/tree/main/#retries).
## Advanced
### Logging
We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
You can enable logging by setting the environment variable `RUNLOOP_LOG` to `debug`.
```shell
$ export RUNLOOP_LOG=debug
```
### How to tell whether `None` means `null` or missing
In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:
```py
if response.my_field is None:
if 'my_field' not in response.model_fields_set:
print('Got json like {}, without a "my_field" key present at all.')
else:
print('Got json like {"my_field": null}.')
```
### Accessing raw response data (e.g. headers)
The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
```py
from runloop_api_client import Runloop
client = Runloop()
response = client.devboxes.with_raw_response.create()
print(response.headers.get('X-My-Header'))
devbox = response.parse() # get the object that `devboxes.create()` would have returned
print(devbox.id)
```
These methods return an [`APIResponse`](https://github.com/runloopai/api-client-python/tree/main/src/runloop_api_client/_response.py) object.
The async client returns an [`AsyncAPIResponse`](https://github.com/runloopai/api-client-python/tree/main/src/runloop_api_client/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
#### `.with_streaming_response`
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.
```python
with client.devboxes.with_streaming_response.create() as response:
print(response.headers.get("X-My-Header"))
for line in response.iter_lines():
print(line)
```
The context manager is required so that the response will reliably be closed.
### Making custom/undocumented requests
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.
#### Undocumented endpoints
To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
http verbs. Options on the client will be respected (such as retries) will be respected when making this
request.
```py
import httpx
response = client.post(
"/foo",
cast_to=httpx.Response,
body={"my_param": True},
)
print(response.headers.get("x-foo"))
```
#### Undocumented request params
If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
options.
#### Undocumented response properties
To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
can also get all the extra fields on the Pydantic model as a dict with
[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
### Configuring the HTTP client
You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:
- Support for proxies
- Custom transports
- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality
```python
from runloop_api_client import Runloop, DefaultHttpxClient
client = Runloop(
# Or use the `RUNLOOP_BASE_URL` env var
base_url="http://my.test.server.example.com:8083",
http_client=DefaultHttpxClient(
proxies="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 using `with_options()`:
```python
client.with_options(http_client=DefaultHttpxClient(...))
```
### Managing HTTP resources
By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
## Versioning
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) 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 an [issue](https://www.github.com/runloopai/api-client-python/issues) with questions, bugs, or suggestions.
### Determining the installed version
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:
```py
import runloop_api_client
print(runloop_api_client.__version__)
```
## Requirements
Python 3.8 or higher.
## Contributing
See [the contributing documentation](https://github.com/runloopai/api-client-python/tree/main/./CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "runloop-api-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Runloop <support@runloop.ai>",
"download_url": "https://files.pythonhosted.org/packages/dc/96/2be7d13e85fdee91c7befb0c482839d686519f7aab3e907ea57ff4517465/runloop_api_client-0.9.0.tar.gz",
"platform": null,
"description": "# Runloop Python API library\n\n[](https://pypi.org/project/runloop_api_client/)\n\nThe Runloop Python library provides convenient access to the Runloop REST API from any Python 3.8+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\nIt is generated with [Stainless](https://www.stainlessapi.com/).\n\n## Documentation\n\nThe REST API documentation can be found on [runloop.ai](https://runloop.ai). The full API of this library can be found in [api.md](https://github.com/runloopai/api-client-python/tree/main/api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install runloop_api_client\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](https://github.com/runloopai/api-client-python/tree/main/api.md).\n\n```python\nimport os\nfrom runloop_api_client import Runloop\n\nclient = Runloop(\n # This is the default and can be omitted\n bearer_token=os.environ.get(\"RUNLOOP_API_KEY\"),\n)\n\ndevbox_view = client.devboxes.create()\nprint(devbox_view.id)\n```\n\nWhile you can provide a `bearer_token` keyword argument,\nwe recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)\nto add `RUNLOOP_API_KEY=\"My Bearer Token\"` to your `.env` file\nso that your Bearer Token is not stored in source control.\n\n## Async usage\n\nSimply import `AsyncRunloop` instead of `Runloop` and use `await` with each API call:\n\n```python\nimport os\nimport asyncio\nfrom runloop_api_client import AsyncRunloop\n\nclient = AsyncRunloop(\n # This is the default and can be omitted\n bearer_token=os.environ.get(\"RUNLOOP_API_KEY\"),\n)\n\n\nasync def main() -> None:\n devbox_view = await client.devboxes.create()\n print(devbox_view.id)\n\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped 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, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `runloop_api_client.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `runloop_api_client.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `runloop_api_client.APIError`.\n\n```python\nimport runloop_api_client\nfrom runloop_api_client import Runloop\n\nclient = Runloop()\n\ntry:\n client.devboxes.create()\nexcept runloop_api_client.APIConnectionError as e:\n print(\"The server could not be reached\")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept runloop_api_client.RateLimitError as e:\n print(\"A 429 status code was received; we should back off a bit.\")\nexcept runloop_api_client.APIStatusError as e:\n print(\"Another non-200-range status code was received\")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as followed:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom runloop_api_client import Runloop\n\n# Configure the default for all requests:\nclient = Runloop(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries=5).devboxes.create()\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:\n\n```python\nfrom runloop_api_client import Runloop\n\n# Configure the default for all requests:\nclient = Runloop(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = Runloop(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout=5.0).devboxes.create()\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](https://github.com/runloopai/api-client-python/tree/main/#retries).\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `RUNLOOP_LOG` to `debug`.\n\n```shell\n$ export RUNLOOP_LOG=debug\n```\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if 'my_field' not in response.model_fields_set:\n print('Got json like {}, without a \"my_field\" key present at all.')\n else:\n print('Got json like {\"my_field\": null}.')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe \"raw\" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom runloop_api_client import Runloop\n\nclient = Runloop()\nresponse = client.devboxes.with_raw_response.create()\nprint(response.headers.get('X-My-Header'))\n\ndevbox = response.parse() # get the object that `devboxes.create()` would have returned\nprint(devbox.id)\n```\n\nThese methods return an [`APIResponse`](https://github.com/runloopai/api-client-python/tree/main/src/runloop_api_client/_response.py) object.\n\nThe async client returns an [`AsyncAPIResponse`](https://github.com/runloopai/api-client-python/tree/main/src/runloop_api_client/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo 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.\n\n```python\nwith client.devboxes.with_streaming_response.create() as response:\n print(response.headers.get(\"X-My-Header\"))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) will be respected when making this\nrequest.\n\n```py\nimport httpx\n\nresponse = client.post(\n \"/foo\",\n cast_to=httpx.Response,\n body={\"my_param\": True},\n)\n\nprint(response.headers.get(\"x-foo\"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for proxies\n- Custom transports\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nfrom runloop_api_client import Runloop, DefaultHttpxClient\n\nclient = Runloop(\n # Or use the `RUNLOOP_BASE_URL` env var\n base_url=\"http://my.test.server.example.com:8083\",\n http_client=DefaultHttpxClient(\n proxies=\"http://my.test.proxy.example.com\",\n transport=httpx.HTTPTransport(local_address=\"0.0.0.0\"),\n ),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. 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)_.\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/runloopai/api-client-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf 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.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport runloop_api_client\nprint(runloop_api_client.__version__)\n```\n\n## Requirements\n\nPython 3.8 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/runloopai/api-client-python/tree/main/./CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": null,
"summary": "The official Python library for the runloop API",
"version": "0.9.0",
"project_urls": {
"Homepage": "https://github.com/runloopai/api-client-python",
"Repository": "https://github.com/runloopai/api-client-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "90734ee857f94c70abb8616450b05807a7d20b16f07202288cf0228e1210ff6b",
"md5": "4ebe1f5a4e056e2811821132987d78a8",
"sha256": "f5b03a1a934e4c5cfa07c0463d2f2d76a95ca87aa21ecc193408ad206100a83c"
},
"downloads": -1,
"filename": "runloop_api_client-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ebe1f5a4e056e2811821132987d78a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 111772,
"upload_time": "2024-11-07T19:29:05",
"upload_time_iso_8601": "2024-11-07T19:29:05.529978Z",
"url": "https://files.pythonhosted.org/packages/90/73/4ee857f94c70abb8616450b05807a7d20b16f07202288cf0228e1210ff6b/runloop_api_client-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc962be7d13e85fdee91c7befb0c482839d686519f7aab3e907ea57ff4517465",
"md5": "83d53a0ceb20c1dcdc43a686aed8aca3",
"sha256": "d0ad5325e8859b7aa167afdd85774727ba35e01f547f70deb4f52a06d1ddaf14"
},
"downloads": -1,
"filename": "runloop_api_client-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "83d53a0ceb20c1dcdc43a686aed8aca3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 112707,
"upload_time": "2024-11-07T19:29:07",
"upload_time_iso_8601": "2024-11-07T19:29:07.519711Z",
"url": "https://files.pythonhosted.org/packages/dc/96/2be7d13e85fdee91c7befb0c482839d686519f7aab3e907ea57ff4517465/runloop_api_client-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 19:29:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "runloopai",
"github_project": "api-client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "runloop-api-client"
}
