| Name | demo-1-sdk JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | |
| Summary | An APIMatic demo |
| upload_time | 2023-09-12 03:00:35 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
api
petstore
sdk
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Getting Started with Petstore
## Introduction
The API enables users to view detailed information about a specific pet store and its available pets. The API can be used by pet owners, pet adoption agencies, and anyone looking for information about pets in a particular area.
## 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 demo-1-sdk==1.1.0
```
You can also view the package at:
https://pypi.python.org/pypi/demo-1-sdk/1.1.0
## 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/SidneyAllen/demo-1-python-sdk/tree/1.1.0/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']** |
| `access_token` | `str` | The OAuth 2.0 Access Token to use for API requests. |
The API client can be initialized as follows:
```python
from petstore.petstore_client import PetstoreClient
from petstore.configuration import Environment
client = PetstoreClient(
access_token='AccessToken',
environment=Environment.PRODUCTION
)
```
## Authorization
This API uses `OAuth 2 Bearer token`.
## List of APIs
* [Pets](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/controllers/pets.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/http-request.md)
Raw data
{
"_id": null,
"home_page": "",
"name": "demo-1-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "API,Petstore,SDK",
"author": "",
"author_email": "APIMatic Team <support@apimatic.io>",
"download_url": "https://files.pythonhosted.org/packages/09/49/23f3e5ba500bdcaec7ec039ad5258e005e0723e5e89d6494d5b4a3c98468/demo-1-sdk-1.1.0.tar.gz",
"platform": null,
"description": "\n# Getting Started with Petstore\n\n## Introduction\n\nThe API enables users to view detailed information about a specific pet store and its available pets. The API can be used by pet owners, pet adoption agencies, and anyone looking for information about pets in a particular area.\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 demo-1-sdk==1.1.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/demo-1-sdk/1.1.0\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/SidneyAllen/demo-1-python-sdk/tree/1.1.0/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| `access_token` | `str` | The OAuth 2.0 Access Token to use for API requests. |\n\nThe API client can be initialized as follows:\n\n```python\nfrom petstore.petstore_client import PetstoreClient\nfrom petstore.configuration import Environment\n\nclient = PetstoreClient(\n access_token='AccessToken',\n environment=Environment.PRODUCTION\n)\n```\n\n## Authorization\n\nThis API uses `OAuth 2 Bearer token`.\n\n## List of APIs\n\n* [Pets](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/controllers/pets.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "An APIMatic demo",
"version": "1.1.0",
"project_urls": {
"Documentation": "https://docs.apimatic.io"
},
"split_keywords": [
"api",
"petstore",
"sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d32eff2f005e2fb6a62abec71c3ba395691a72d4537b1e273ed0b0ba09305dd4",
"md5": "48ae71921a89e86f7f43540630b1f543",
"sha256": "189877761b443e00d676a65e18153ce01610d36006b847b965913274a90467cb"
},
"downloads": -1,
"filename": "demo_1_sdk-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48ae71921a89e86f7f43540630b1f543",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 17281,
"upload_time": "2023-09-12T03:00:33",
"upload_time_iso_8601": "2023-09-12T03:00:33.614192Z",
"url": "https://files.pythonhosted.org/packages/d3/2e/ff2f005e2fb6a62abec71c3ba395691a72d4537b1e273ed0b0ba09305dd4/demo_1_sdk-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "094923f3e5ba500bdcaec7ec039ad5258e005e0723e5e89d6494d5b4a3c98468",
"md5": "cf087dc8dd460c54512f63b7e68a74d9",
"sha256": "0765209f6c94fab39f0c21c23c3f45b45c1840b34d5ad6f01a22c563339d7f36"
},
"downloads": -1,
"filename": "demo-1-sdk-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "cf087dc8dd460c54512f63b7e68a74d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 10333,
"upload_time": "2023-09-12T03:00:35",
"upload_time_iso_8601": "2023-09-12T03:00:35.428412Z",
"url": "https://files.pythonhosted.org/packages/09/49/23f3e5ba500bdcaec7ec039ad5258e005e0723e5e89d6494d5b4a3c98468/demo-1-sdk-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-12 03:00:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "demo-1-sdk"
}
