This project has been archived by its maintainers, and is no longer receiving any updates.
Getting Started with gumlet-rest-apis
Install the Package
The package is compatible with Python versions 3.7+.
Install the package from PyPi using the following pip command:
pip install gumlet-python-sdk==1.0.0
You can also view the package at: https://pypi.python.org/pypi/gumlet-python-sdk/1.0.0
Test the SDK
You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:
Navigate to the root directory of the SDK and run the following commands
pip install -r test-requirements.txt
pytest
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| http_client_instance | HttpClient |
The Http Client passed from the sdk user for making requests |
| override_http_client_configuration | bool |
The value which determines to override properties of the passed Http Client from the sdk user |
| http_call_back | HttpCallBack |
The callback value that is invoked before and after an HTTP call is made to an endpoint |
| timeout | float |
The value to use for connection timeout. Default: 60 |
| max_retries | int |
The number of times to retry an endpoint call if it fails. Default: 0 |
| backoff_factor | float |
A backoff factor to apply between attempts after the second try. Default: 2 |
| retry_statuses | Array of int |
The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
| retry_methods | Array of string |
The http methods on which retry is to be done. Default: ['GET', 'PUT'] |
| custom_header_authentication_credentials | CustomHeaderAuthenticationCredentials |
The credential object for Custom Header Signature |
The API client can be initialized as follows:
client = GumletrestapisClient(
custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
authorization='Authorization'
),
environment=Environment.PRODUCTION
)
Authorization
This API uses the following authentication schemes.
List of APIs
SDK Infrastructure
HTTP
Utilities
2 maintainers
Release files for gumlet-python-sdk 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gumlet_python_sdk-1.0.0.tar.gz | 89.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gumlet_python_sdk-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 379.0 kB
Release files / gumlet_python_sdk-1.0.0.tar.gz
| Download URL | gumlet_python_sdk-1.0.0.tar.gz |
|---|---|
| Size | 89.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2076d51586328a98811000504a1c79de3d27a7f38f71a20be5bdda63ab1a6ed9
|
|
BLAKE2b-256 checksum How to use checksums |
03c0843935dde270368fac754be53461392ceff28c6919f35264c2d2137cd2c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.13
|
Release files / gumlet_python_sdk-1.0.0-py3-none-any.whl
| Download URL | gumlet_python_sdk-1.0.0-py3-none-any.whl |
|---|---|
| Size | 289.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
799c34eaba38371baeb9e430342eaeb7174ca699d374bcfd098d579a0a6c6b88
|
|
BLAKE2b-256 checksum How to use checksums |
8d0e336f3ebf3a76a3aa732328395cbe125e3f8a9986f2d282da69c46c4b5d00
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.13
|
