This release is a pre-release and may not be stable for production use.
Pinnacle Python Library
The Pinnacle Python library provides convenient access to the Pinnacle APIs from Python.
Table of Contents
Installation
pip install rcs
Reference
A full reference for this library is available here.
Usage
Instantiate and use the client with the following:
from rcs import Pinnacle
from rcs.brands import AutofillBrandOptions
client = Pinnacle(
api_key="YOUR_API_KEY",
)
client.brands.autofill(
additional_info="A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
name="Pinnacle",
options=AutofillBrandOptions(
force_reload=True,
),
website="https://www.pinnacle.sh",
)
Async Client
The SDK also exports an async client so that you can make non-blocking calls to our API.
import asyncio
from rcs import AsyncPinnacle
from rcs.brands import AutofillBrandOptions
client = AsyncPinnacle(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.brands.autofill(
additional_info="A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
name="Pinnacle",
options=AutofillBrandOptions(
force_reload=True,
),
website="https://www.pinnacle.sh",
)
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 rcs.core.api_error import ApiError
try:
client.brands.autofill(...)
except ApiError as e:
print(e.status_code)
print(e.body)
Advanced
Access Raw Response Data
The SDK provides access to raw response data, including headers, through the .with_raw_response property.
The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.
from rcs import Pinnacle
client = Pinnacle(
...,
)
response = client.brands.with_raw_response.autofill(...)
print(response.headers) # access the response headers
print(response.data) # access the underlying object
Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
Use the max_retries request option to configure this behavior.
client.brands.autofill(..., request_options={
"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 rcs import Pinnacle
client = Pinnacle(
...,
timeout=20.0,
)
# Override timeout for a specific method
client.brands.autofill(..., request_options={
"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 rcs import Pinnacle
client = Pinnacle(
...,
httpx_client=httpx.Client(
proxy="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
Metadata
1 maintainer
Release files for rcs 2.0.27rc1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rcs-2.0.27rc1.tar.gz | 236.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rcs-2.0.27rc1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 811.9 kB
Release files / rcs-2.0.27rc1.tar.gz
| Download URL | rcs-2.0.27rc1.tar.gz |
|---|---|
| Size | 236.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a334e1e884cee06458243fabb77b6d009c6791f188e41c63395f1863572cd6b9
|
|
BLAKE2b-256 checksum How to use checksums |
8371052eb4b61c618054dda0f8498944fb64b103228538019382d9f480ceda38
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.8.18 Linux/6.17.0-1022-azure
|
Release files / rcs-2.0.27rc1-py3-none-any.whl
| Download URL | rcs-2.0.27rc1-py3-none-any.whl |
|---|---|
| Size | 575.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
536cf4a0b389b0eb57dcb4f72c33053cf21b675e993687a62e030de4c4ed1f26
|
|
BLAKE2b-256 checksum How to use checksums |
ee7f6bc3826b3ab7c787e1af823d6fa5a4c5d32f24c2d61bc5a49568cd5d4586
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.8.18 Linux/6.17.0-1022-azure
|
