TestSdk Python SDK 1.0.0
Welcome to the TestSdk SDK documentation. This guide will help you get started with integrating and using the TestSdk SDK in your project.
Versions
- API version:
v1 - SDK version:
1.0.0
About the API
The public Abbey API. Used for integrating with Abbey and building interfaces to extend the Abbey platform.\nSee https://docs.abbey.io for more information.\n
Table of Contents
- Setup & Configuration
- Authentication
- Setting a Custom Timeout
- Sample Usage
- Async Usage
- Services
- Models
- License
Setup & Configuration
Supported Language Versions
This SDK is compatible with the following versions: Python >= 3.7
Installation
To get started with the SDK, we recommend installing using pip:
pip install test_sdk
Authentication
Access Token Authentication
The TestSdk API uses an Access Token for authentication.
This token must be provided to authenticate your requests to the API.
Setting the Access Token
When you initialize the SDK, you can set the access token as follows:
TestSdk(
access_token="YOUR_ACCESS_TOKEN",
timeout=10000
)
If you need to set or update the access token after initializing the SDK, you can use:
sdk.set_access_token("YOUR_ACCESS_TOKEN")
Setting a Custom Timeout
You can set a custom timeout for the SDK's HTTP requests as follows:
from test_sdk import TestSdk
sdk = TestSdk(timeout=10000)
Sample Usage
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
from test_sdk import TestSdk
sdk = TestSdk(
access_token="YOUR_ACCESS_TOKEN",
timeout=10000
)
result = sdk.grant_kits.list_grant_kits()
print(result)
Async Usage
The SDK includes an Async Client for making asynchronous API requests. This is useful for applications that need non-blocking operations, like web servers or apps with a graphical user interface.
import asyncio
from test_sdk import TestSdkAsync
sdk = TestSdkAsync(
access_token="YOUR_ACCESS_TOKEN",
timeout=10000
)
async def main():
result = await sdk.grant_kits.list_grant_kits()
print(result)
asyncio.run(main())
Services
The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
Models
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
License
This SDK is licensed under the MIT License.
See the LICENSE file for more details.