Name | apimatic-calculator-97-sdk JSON |
Version |
1.0.1
JSON |
| download |
home_page | |
Summary | This is a long description |
upload_time | 2023-06-04 18:13:13 |
maintainer | |
docs_url | None |
author | |
requires_python | >=3.7 |
license | |
keywords |
demo
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 apimatic-calculator-97-sdk==1.0.1
```
You can also view the package at:
https://pypi.python.org/pypi/apimatic-calculator-97-sdk/1.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/shield-jaguar/apimatic-calculator-97-python-sdk/tree/1.0.1/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
from apimaticcalculator.apimaticcalculator_client import ApimaticcalculatorClient
from apimaticcalculator.configuration import Environment
client = ApimaticcalculatorClient()
```
## List of APIs
* [Simple Calculator](https://www.github.com/shield-jaguar/apimatic-calculator-97-python-sdk/tree/1.0.1/doc/controllers/simple-calculator.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/shield-jaguar/apimatic-calculator-97-python-sdk/tree/1.0.1/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/shield-jaguar/apimatic-calculator-97-python-sdk/tree/1.0.1/doc/http-response.md)
* [HttpRequest](https://www.github.com/shield-jaguar/apimatic-calculator-97-python-sdk/tree/1.0.1/doc/http-request.md)
Raw data
{
"_id": null,
"home_page": "",
"name": "apimatic-calculator-97-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "demo,test",
"author": "",
"author_email": "Mujahid Apimatic <mujahid.khan@apimatic.io>",
"download_url": "https://files.pythonhosted.org/packages/b5/58/b7a52e96d7e1b5010cc4ed14391646ab77fbec75ee629fae7cd05aa424db/apimatic-calculator-97-sdk-1.0.1.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 apimatic-calculator-97-sdk==1.0.1\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/apimatic-calculator-97-sdk/1.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/shield-jaguar/apimatic-calculator-97-python-sdk/tree/1.0.1/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\nfrom apimaticcalculator.apimaticcalculator_client import ApimaticcalculatorClient\nfrom apimaticcalculator.configuration import Environment\n\nclient = ApimaticcalculatorClient()\n```\n\n## List of APIs\n\n* [Simple Calculator](https://www.github.com/shield-jaguar/apimatic-calculator-97-python-sdk/tree/1.0.1/doc/controllers/simple-calculator.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/shield-jaguar/apimatic-calculator-97-python-sdk/tree/1.0.1/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/shield-jaguar/apimatic-calculator-97-python-sdk/tree/1.0.1/doc/http-response.md)\n* [HttpRequest](https://www.github.com/shield-jaguar/apimatic-calculator-97-python-sdk/tree/1.0.1/doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "This is a long description",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://docs.apimatic.io"
},
"split_keywords": [
"demo",
"test"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "133ac264753dcb1d3537c2350661c800f91d484b55925d9f8809a3f841b1fe85",
"md5": "18fcc5ba43f6ec0f8e3ed927d0880efd",
"sha256": "370b06b2a55953e0afbb2eafde5232f5e43cc16013d04ff1137ea16ac81563f9"
},
"downloads": -1,
"filename": "apimatic_calculator_97_sdk-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "18fcc5ba43f6ec0f8e3ed927d0880efd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 14056,
"upload_time": "2023-06-04T18:13:10",
"upload_time_iso_8601": "2023-06-04T18:13:10.921193Z",
"url": "https://files.pythonhosted.org/packages/13/3a/c264753dcb1d3537c2350661c800f91d484b55925d9f8809a3f841b1fe85/apimatic_calculator_97_sdk-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b558b7a52e96d7e1b5010cc4ed14391646ab77fbec75ee629fae7cd05aa424db",
"md5": "c8317dc250e76eb64434140a80e0f234",
"sha256": "f435f8e6b5d21e9522a857e2a2c3670f18dfae803bdfd9e7c164dbfc69d80ac2"
},
"downloads": -1,
"filename": "apimatic-calculator-97-sdk-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c8317dc250e76eb64434140a80e0f234",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8463,
"upload_time": "2023-06-04T18:13:13",
"upload_time_iso_8601": "2023-06-04T18:13:13.058802Z",
"url": "https://files.pythonhosted.org/packages/b5/58/b7a52e96d7e1b5010cc4ed14391646ab77fbec75ee629fae7cd05aa424db/apimatic-calculator-97-sdk-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-04 18:13:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "apimatic-calculator-97-sdk"
}