| Name | sdksio-apimatic-sdk JSON |
| Version |
3.0.0
JSON |
| download |
| home_page | None |
| Summary | Use APIMatic API to generate SDKs in Python, Typescript, PHP, Ruby, and GO. You can generate On-Prem portal and many more. |
| upload_time | 2024-04-08 10:41:04 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
apimatic
sdk
api
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Getting Started with Apimatic API
## Introduction
This API gives you programmatic access to APIMatic's Code Generation, Docs Generation and Transformation Engine
## 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 sdksio-apimatic-sdk==3.0.0
```
You can also view the package at:
https://pypi.python.org/pypi/sdksio-apimatic-sdk/3.0.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/sdks-io/apimatic-python-sdk/tree/3.0.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, 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', 'GET', 'PUT']** |
| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/$a/https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/custom-header-signature.md) | The credential object for Custom Header Signature |
The API client can be initialized as follows:
```python
client = ApimaticapiClient(
custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
authorization='Authorization'
),
environment=Environment.PRODUCTION
)
```
## Authorization
This API uses the following authentication schemes.
* [`Authorization (Custom Header Signature)`](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/$a/https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/custom-header-signature.md)
## List of APIs
* [APIs Management](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/apis-management.md)
* [Code Generation-Imported APIs](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/code-generation-imported-apis.md)
* [Code Generation-External APIs](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/code-generation-external-apis.md)
* [Docs Portal Management](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/docs-portal-management.md)
* [API Validation-Imported APIs](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/api-validation-imported-apis.md)
* [API Validation-External APIs](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/api-validation-external-apis.md)
* [Transformation](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/transformation.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/http-request.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "sdksio-apimatic-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "APIMatic, SDK, API",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/6d/0e/df23ee5102cf09b14d5eab3983ee53143749f2d438a0dbf9ad6f5641af8b/sdksio-apimatic-sdk-3.0.0.tar.gz",
"platform": null,
"description": "\n# Getting Started with Apimatic API\n\n## Introduction\n\nThis API gives you programmatic access to APIMatic's Code Generation, Docs Generation and Transformation Engine\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 sdksio-apimatic-sdk==3.0.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/sdksio-apimatic-sdk/3.0.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/sdks-io/apimatic-python-sdk/tree/3.0.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, 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', 'GET', 'PUT']** |\n| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/$a/https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/custom-header-signature.md) | The credential object for Custom Header Signature |\n\nThe API client can be initialized as follows:\n\n```python\nclient = ApimaticapiClient(\n custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(\n authorization='Authorization'\n ),\n environment=Environment.PRODUCTION\n)\n```\n\n## Authorization\n\nThis API uses the following authentication schemes.\n\n* [`Authorization (Custom Header Signature)`](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/$a/https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/custom-header-signature.md)\n\n## List of APIs\n\n* [APIs Management](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/apis-management.md)\n* [Code Generation-Imported APIs](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/code-generation-imported-apis.md)\n* [Code Generation-External APIs](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/code-generation-external-apis.md)\n* [Docs Portal Management](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/docs-portal-management.md)\n* [API Validation-Imported APIs](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/api-validation-imported-apis.md)\n* [API Validation-External APIs](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/api-validation-external-apis.md)\n* [Transformation](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/controllers/transformation.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sdks-io/apimatic-python-sdk/tree/3.0.0/doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Use APIMatic API to generate SDKs in Python, Typescript, PHP, Ruby, and GO. You can generate On-Prem portal and many more.",
"version": "3.0.0",
"project_urls": null,
"split_keywords": [
"apimatic",
" sdk",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c65a48d99577a1d5223471c6d353f872ecc146ff35cd039561fecd2b89ea0c70",
"md5": "a77976133366eccee1b68b53402cbe00",
"sha256": "112ad5ac52ad58ffc83b4ee3bedf1ab565dd9d1c16925dd98e16d59486388d27"
},
"downloads": -1,
"filename": "sdksio_apimatic_sdk-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a77976133366eccee1b68b53402cbe00",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 72139,
"upload_time": "2024-04-08T10:41:02",
"upload_time_iso_8601": "2024-04-08T10:41:02.618483Z",
"url": "https://files.pythonhosted.org/packages/c6/5a/48d99577a1d5223471c6d353f872ecc146ff35cd039561fecd2b89ea0c70/sdksio_apimatic_sdk-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d0edf23ee5102cf09b14d5eab3983ee53143749f2d438a0dbf9ad6f5641af8b",
"md5": "2a31d30cea6bedfbbb155eae70c0d368",
"sha256": "90ee5456ca31ced3612104c3c648933d9494b1e228cd5c64ceed7510bebe4281"
},
"downloads": -1,
"filename": "sdksio-apimatic-sdk-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2a31d30cea6bedfbbb155eae70c0d368",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 32852,
"upload_time": "2024-04-08T10:41:04",
"upload_time_iso_8601": "2024-04-08T10:41:04.704028Z",
"url": "https://files.pythonhosted.org/packages/6d/0e/df23ee5102cf09b14d5eab3983ee53143749f2d438a0dbf9ad6f5641af8b/sdksio-apimatic-sdk-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-08 10:41:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sdksio-apimatic-sdk"
}
