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.0You can also view the package at: https://pypi.python.org/pypi/gumlet-python-sdk/1.0.0
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
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
)This API uses the following authentication schemes.