| Name | packageee-213-sdk JSON |
| Version |
1.2.3
JSON |
| download |
| home_page | None |
| Summary | test |
| upload_time | 2024-08-07 08:25:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
test
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Getting Started with APIMATIC Calculator
## Introduction
Simple calculator API hosted on APIMATIC
## 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 packageee-213-sdk==1.2.3
```
You can also view the package at:
https://pypi.python.org/pypi/packageee-213-sdk/1.2.3
## 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/ZahraN444/pythonrepo/tree/1.2.3/doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
| `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']** |
The API client can be initialized as follows:
```python
client = ApimaticcalculatorClient()
```
## List of APIs
* [Simple Calculator](https://www.github.com/ZahraN444/pythonrepo/tree/1.2.3/doc/controllers/simple-calculator.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/ZahraN444/pythonrepo/tree/1.2.3/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/ZahraN444/pythonrepo/tree/1.2.3/doc/http-response.md)
* [HttpRequest](https://www.github.com/ZahraN444/pythonrepo/tree/1.2.3/doc/http-request.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "packageee-213-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "test",
"author": null,
"author_email": "Zahra <zahranaseem444@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4b/72/f607344424e1837de775c33be715da06ab067f52d057992f0bd5df9b3cc2/packageee_213_sdk-1.2.3.tar.gz",
"platform": null,
"description": "\n# Getting Started with APIMATIC Calculator\n\n## Introduction\n\nSimple calculator API hosted on APIMATIC\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 packageee-213-sdk==1.2.3\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/packageee-213-sdk/1.2.3\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/ZahraN444/pythonrepo/tree/1.2.3/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |\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\nThe API client can be initialized as follows:\n\n```python\nclient = ApimaticcalculatorClient()\n```\n\n## List of APIs\n\n* [Simple Calculator](https://www.github.com/ZahraN444/pythonrepo/tree/1.2.3/doc/controllers/simple-calculator.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/ZahraN444/pythonrepo/tree/1.2.3/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/ZahraN444/pythonrepo/tree/1.2.3/doc/http-response.md)\n* [HttpRequest](https://www.github.com/ZahraN444/pythonrepo/tree/1.2.3/doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "test",
"version": "1.2.3",
"project_urls": {
"Documentation": "https://apimatic.io"
},
"split_keywords": [
"test"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7914bb9d85fa72c39cb8cda47b93920dae53a12a600b95b59942013183a1b13c",
"md5": "61b22770e929bf6278dfc9c6678cdcf1",
"sha256": "c75681716bf92ea2d929e46e4b86e7b2bade473341c8fe39a600db556e739036"
},
"downloads": -1,
"filename": "packageee_213_sdk-1.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "61b22770e929bf6278dfc9c6678cdcf1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13818,
"upload_time": "2024-08-07T08:25:23",
"upload_time_iso_8601": "2024-08-07T08:25:23.135305Z",
"url": "https://files.pythonhosted.org/packages/79/14/bb9d85fa72c39cb8cda47b93920dae53a12a600b95b59942013183a1b13c/packageee_213_sdk-1.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b72f607344424e1837de775c33be715da06ab067f52d057992f0bd5df9b3cc2",
"md5": "08873d335c4dc61ef91be3137ed09da1",
"sha256": "930b3be985c89c112aabe24561a0dc15aac9cecc40462557ff4403b2d9bc3260"
},
"downloads": -1,
"filename": "packageee_213_sdk-1.2.3.tar.gz",
"has_sig": false,
"md5_digest": "08873d335c4dc61ef91be3137ed09da1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9539,
"upload_time": "2024-08-07T08:25:24",
"upload_time_iso_8601": "2024-08-07T08:25:24.478741Z",
"url": "https://files.pythonhosted.org/packages/4b/72/f607344424e1837de775c33be715da06ab067f52d057992f0bd5df9b3cc2/packageee_213_sdk-1.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-07 08:25:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "packageee-213-sdk"
}
