The Wootiv Python library provides convenient access to the Wootiv REST API from any Python 3.7+ application. It includes type definitions for all request params and response fields, and offers both synchronous and asynchronous clients powered by httpx.
The API documentation can be found here.
pip install wootivfrom wootiv import Wootiv
client = Wootiv(
# defaults to os.environ.get("WOOTIV_API_KEY")
api_key="my api key",
# defaults to "production".
environment="environment_1",
)
aw = client.aws.create_signed_put_url(
filename="sunshine.png",
)
print(aw.url)While you can provide an api_key keyword argument, we recommend using python-dotenv
and adding WOOTIV_API_KEY="my api key" to your .env file so that your API Key is not stored in source control.
Simply import AsyncWootiv instead of Wootiv and use await with each API call:
from wootiv import AsyncWootiv
client = AsyncWootiv(
# defaults to os.environ.get("WOOTIV_API_KEY")
api_key="my api key",
# defaults to "production".
environment="environment_1",
)
async def main():
aw = await client.aws.create_signed_put_url(
filename="sunshine.png",
)
print(aw.url)
asyncio.run(main())Functionality between the synchronous and asynchronous clients is otherwise identical.
Nested request parameters are TypedDicts. Responses are Pydantic models, which provide helper methods for things like serializing back into json (v1, v2). To get a dictionary, you can call dict(model).
This helps 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".
List methods in the Wootiv API are paginated.
This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
import wootiv
client = Wootiv()
all_members = []
# Automatically fetches more pages as needed.
for member in client.space.members.list(
"<id>",
):
# Do something with member here
all_members.append(member)
print(all_members)Or, asynchronously:
import asyncio
import wootiv
client = AsyncWootiv()
async def main() -> None:
all_members = []
# Iterate through items across all pages, issuing requests as needed.
async for member in client.space.members.list(
"<id>",
):
all_members.append(member)
print(all_members)
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:
Nested parameters are dictionaries, typed using TypedDict, for example:
from wootiv import Wootiv
client = Wootiv()
client.root.retrieve(
params={},
)When the library is unable to connect to the API (e.g., due to network connection problems or a timeout), a subclass of wootiv.APIConnectionError is raised.
When the API returns a non-success status code (i.e., 4xx or 5xx
response), a subclass of wootiv.APIStatusError will be raised, containing status_code and response properties.
All errors inherit from wootiv.APIError.
import wootiv
from wootiv import Wootiv
client = Wootiv()
try:
client.aws.create_signed_put_url(
filename="sunshine.png",
)
except wootiv.APIConnectionError as e:
print("The server could not be reached")
print(e.__cause__) # an underlying Exception, likely raised within httpx.
except wootiv.RateLimitError as e:
print("A 429 status code was received; we should back off a bit.")
except wootiv.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 |
Certain errors will be automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default.
You can use the max_retries option to configure or disable this:
from wootiv import Wootiv
# Configure the default for all requests:
client = Wootiv(
# default is 2
max_retries=0,
)
# Or, configure per-request:
client.with_options(max_retries=5).root.retrieve()Requests time out after 1 minute by default. You can configure this with a timeout option,
which accepts a float or an httpx.Timeout:
from wootiv import Wootiv
# Configure the default for all requests:
client = Wootiv(
# default is 60s
timeout=20.0,
)
# More granular control:
client = Wootiv(
timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)
# Override per-request:
client.with_options(timeout=5 * 1000).root.retrieve()On timeout, an APITimeoutError is thrown.
Note that requests which time out will be retried twice by default.
You can configure the following keyword arguments when instantiating the client:
import httpx
from wootiv import Wootiv
client = Wootiv(
# Use a custom base URL
base_url="http://my.test.server.example.com:8083",
proxies="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
)See the httpx documentation for information about the proxies and transport keyword arguments.
By default we will close the underlying HTTP connections whenever the client is garbage collected is called but you can also manually close the client using the .close() method if desired, or with a context manager that closes when exiting.
This package generally attempts to follow SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- Changes that only affect static types, without breaking runtime behavior.
- 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).
- 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 with questions, bugs, or suggestions.
Python 3.7 or higher.