Planpoint Python Library
The Planpoint Python library provides convenient access to the Planpoint APIs from Python.
Table of Contents
Installation
pip install planpoint-sdk
Usage
Instantiate and use the client with the following:
from planpoint import PlanpointApi
client = PlanpointApi(
token="YOUR_TOKEN",
)
client.authentication.login(
username="user@example.com",
)
Async Client
The SDK also exports an async client so that you can make non-blocking calls to our API.
import asyncio
from planpoint import AsyncPlanpointApi
client = AsyncPlanpointApi(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.authentication.login(
username="user@example.com",
)
asyncio.run(main())
Exception Handling
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.
from planpoint.core.api_error import ApiError
try:
client.authentication.login(...)
except ApiError as e:
print(e.status_code)
print(e.body)
Advanced
Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
A request is deemed retriable when any of the following HTTP status codes is returned:
Use the max_retries request option to configure this behavior.
client.authentication.login(..., {
"max_retries": 1
})
Timeouts
The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
from planpoint import PlanpointApi
client = PlanpointApi(
...,
timeout=20.0,
)
# Override timeout for a specific method
client.authentication.login(..., {
"timeout_in_seconds": 1
})
Custom Client
You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies
and transports.
import httpx
from planpoint import PlanpointApi
client = PlanpointApi(
...,
httpx_client=httpx.Client(
proxies="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)
Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
1 maintainer
Release files for planpoint-sdk 0.0.56
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| planpoint_sdk-0.0.56.tar.gz | 27.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| planpoint_sdk-0.0.56-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 78.4 kB
Release files / planpoint_sdk-0.0.56.tar.gz
| Download URL | planpoint_sdk-0.0.56.tar.gz |
|---|---|
| Size | 27.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3de3fe6b087c4cce9549da7cc5315e712f7e47be371d71ff6cd3f96f416c7630
|
|
BLAKE2b-256 checksum How to use checksums |
cc62ff967d4e628ad013344392dfc965e708855a3b9fc7562624619e08e22b92
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.9.14 Linux/4.14.348-265.565.amzn2.x86_64
|
Release files / planpoint_sdk-0.0.56-py3-none-any.whl
| Download URL | planpoint_sdk-0.0.56-py3-none-any.whl |
|---|---|
| Size | 51.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
16c27e37c4a069716f83658b54ead82cc17ed424fe2225a1820bad3b6aa33755
|
|
BLAKE2b-256 checksum How to use checksums |
27286a0a0e26effeecc7f56a0c3196b0a1d4f06cf25046a881346bbe7a99e9a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.9.14 Linux/4.14.348-265.565.amzn2.x86_64
|
