This is a test client sdk.
Project description
Getting Started with Words API
Introduction
Words API lets you retrieve information about English words, including definitions, synonyms, rhymes, pronunciation, syllables, and frequency of usage. It also can tell you about relationships between words, for instance that “math” has categories like “algebra” and “geometry”, or that a “finger” is part of a “hand”.
Install the Package
The package is compatible with Python versions 3 >=3.7, <= 3.11
.
Install the package from PyPi using the following pip command:
pip install words-api-client==1.0.2
You can also view the package at: https://pypi.python.org/pypi/words-api-client/1.0.2
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 = WordsapiClient(
custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(),
environment=Environment.PRODUCTION
)
Authorization
This API uses the following authentication schemes.
List of APIs
Classes Documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for words_api_client-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 992353df2e8b7f0ba8cd3f48d9071baec5cdea32d551fe2c645d75c7d9cfbabb |
|
MD5 | 726f350622884fa01c3253fc4c9b647a |
|
BLAKE2b-256 | 027fd8d59c6110acc39fe96a53d5dce99d2ec27899e6cd23ab44c1f93f5db0fd |