test-words-api-client-sdk


Nametest-words-api-client-sdk JSON
Version 5.0.1 PyPI version JSON
download
home_pageNone
SummaryWords 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”.
upload_time2024-10-30 07:03:38
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseNone
keywords apimatic
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
# 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:

```python
pip install test-words-api-client-sdk==5.0.1
```

You can also view the package at:
https://pypi.python.org/pypi/test-words-api-client-sdk/5.0.1

## 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.](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/client.md)

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. <br> **Default: 60** |
| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **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. <br> **Default: ['GET', 'PUT']** |
| `logging_configuration` | [`LoggingConfiguration`](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |

The API client can be initialized as follows:

```python
client = WordsapiClient(
    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
        x_rapid_api_key='X-RapidAPI-Key'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)
```

## Authorization

This API uses the following authentication schemes.

* [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/auth/custom-header-signature.md)

## List of APIs

* [AP Is](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/controllers/ap-is.md)

## Classes Documentation

* [Utility Classes](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/http-response.md)
* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/http-request.md)
* [LoggingConfiguration](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/logging-configuration.md)
* [RequestLoggingConfiguration](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/response-logging-configuration.md)
* [AbstractLogger](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/abstract-logger.md)

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "test-words-api-client-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "Apimatic",
    "author": null,
    "author_email": "Sufyan <muhammad.sufyan@apimatic.io>",
    "download_url": "https://files.pythonhosted.org/packages/4c/8f/e72d76d0ffb180c661ca62d4a007c1fcd07e016c1b353079b7cfe0ea4eb0/test_words_api_client_sdk-5.0.1.tar.gz",
    "platform": null,
    "description": "\n# Getting Started with Words API\n\n## Introduction\n\nWords 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 \u201cmath\u201d has categories like \u201calgebra\u201d and \u201cgeometry\u201d, or that a \u201cfinger\u201d is part of a \u201chand\u201d.\n\n## Install the Package\n\nThe package is compatible with Python versions `3 >=3.7, <= 3.11`.\nInstall the package from PyPi using the following pip command:\n\n```python\npip install test-words-api-client-sdk==5.0.1\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/test-words-api-client-sdk/5.0.1\n\n## Test the SDK\n\nYou 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:\n\nNavigate to the root directory of the SDK and run the following commands\n\n```\npip install -r test-requirements.txt\npytest\n```\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n|  --- | --- | --- |\n| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |\n| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |\n| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |\n| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |\n| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |\n| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |\n| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |\n| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |\n| `logging_configuration` | [`LoggingConfiguration`](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |\n| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |\n\nThe API client can be initialized as follows:\n\n```python\nclient = WordsapiClient(\n    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(\n        x_rapid_api_key='X-RapidAPI-Key'\n    ),\n    environment=Environment.PRODUCTION,\n    logging_configuration=LoggingConfiguration(\n        log_level=logging.INFO,\n        request_logging_config=RequestLoggingConfiguration(\n            log_body=True\n        ),\n        response_logging_config=ResponseLoggingConfiguration(\n            log_headers=True\n        )\n    )\n)\n```\n\n## Authorization\n\nThis API uses the following authentication schemes.\n\n* [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/auth/custom-header-signature.md)\n\n## List of APIs\n\n* [AP Is](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/controllers/ap-is.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/http-request.md)\n* [LoggingConfiguration](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/logging-configuration.md)\n* [RequestLoggingConfiguration](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/request-logging-configuration.md)\n* [ResponseLoggingConfiguration](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/response-logging-configuration.md)\n* [AbstractLogger](https://www.github.com/sufyankhanrao/test-words-api-python-sdk/tree/5.0.1/doc/abstract-logger.md)\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "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 \u201cmath\u201d has categories like \u201calgebra\u201d and \u201cgeometry\u201d, or that a \u201cfinger\u201d is part of a \u201chand\u201d.",
    "version": "5.0.1",
    "project_urls": {
        "Documentation": "https://apimatic.io"
    },
    "split_keywords": [
        "apimatic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c257f3b743b3d4ae00f1d60e2cb70e8c20bb87ece5c77e5cf56cfae159637637",
                "md5": "7359b3b5926ba5a7de80a4c1d4351581",
                "sha256": "ed3c45fda1746d43e76bc09f8fca9e0c7fa8bad5dfa8672ab8774c4262e23f94"
            },
            "downloads": -1,
            "filename": "test_words_api_client_sdk-5.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7359b3b5926ba5a7de80a4c1d4351581",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 27932,
            "upload_time": "2024-10-30T07:03:37",
            "upload_time_iso_8601": "2024-10-30T07:03:37.584937Z",
            "url": "https://files.pythonhosted.org/packages/c2/57/f3b743b3d4ae00f1d60e2cb70e8c20bb87ece5c77e5cf56cfae159637637/test_words_api_client_sdk-5.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4c8fe72d76d0ffb180c661ca62d4a007c1fcd07e016c1b353079b7cfe0ea4eb0",
                "md5": "16000b58198cf9d9dd1273ab3ac2092e",
                "sha256": "39dc97ea7b064916450b827d181e042b590332113ebd97d50d051f5c63c55ea0"
            },
            "downloads": -1,
            "filename": "test_words_api_client_sdk-5.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "16000b58198cf9d9dd1273ab3ac2092e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 14654,
            "upload_time": "2024-10-30T07:03:38",
            "upload_time_iso_8601": "2024-10-30T07:03:38.547974Z",
            "url": "https://files.pythonhosted.org/packages/4c/8f/e72d76d0ffb180c661ca62d4a007c1fcd07e016c1b353079b7cfe0ea4eb0/test_words_api_client_sdk-5.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-30 07:03:38",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "test-words-api-client-sdk"
}
None
Elapsed time: 0.41909s