apimatic-requests-client-adapter


Nameapimatic-requests-client-adapter JSON
Version 0.1.5 PyPI version JSON
download
home_pagehttps://github.com/apimatic/requests-client-adapter
SummaryAn adapter for requests client library consumed by the SDKs generated with APIMatic
upload_time2023-08-09 09:53:02
maintainer
docs_urlNone
authorAPIMatic
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # apimatic-requests-client-adapter
[![PyPI][pypi-version]][pypi-apimatic-requests-client-adapter-url]
[![Tests][test-badge]][test-url]
[![Test Coverage][test-coverage-url]][code-climate-url]
[![Licence][license-badge]][license-url]

## Introduction
Requests is a simple, yet elegant, HTTP library. This repository contains the client implementation that uses the requests library for python SDK provided by APIMatic. 

## Version supported 
Currenty APIMatic supports  `Python version 3.7 - 3.11`  hence the apimatic-requests-client-adapter will need the same versions to be supported.

## Installation 
Simply run the command below in your SDK as the apimatic-requests-client-adapter will be added as a dependency in the SDK.
```python
pip install apimatic-requests-client-adapter
```
**Supported Methods Provided by requests-client**

| Method                                                                             | Description                                                                      |
| -----------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
| [`create_default_http_client`](apimatic_requests_client_adapter/requests_client.py)| function to creat a defaultp http client                                         | 
| [`force_retries`](apimatic_requests_client_adapter/requests_client.py)             | Reset retries according to each request                                          | 
| [`execute`](apimatic_requests_client_adapter/requests_client.py)                   | Execute a given HttpRequest to get a string response back                        | 
| [`convert_response`](apimatic_requests_client_adapter/requests_client.py)          | Converts the Response object of the CoreHttpClient into a CoreHttpResponse object|

## Tests
The requests client implementation also contains unit tests to ensure reliability of the implementation and to prevent unwanted breakages.

## Links
* [apimatic-core-interfaces](https://pypi.org/project/apimatic-core-interfaces/)
* [Requests](https://pypi.org/project/requests/)

[pypi-version]: https://img.shields.io/pypi/v/apimatic-requests-client-adapter
[pypi-apimatic-requests-client-adapter-url]: https://pypi.org/project/apimatic-requests-client-adapter/
[test-badge]: https://github.com/apimatic/requests-client-adapter/actions/workflows/test-runner.yml/badge.svg
[test-url]: https://github.com/apimatic/requests-client-adapter/actions/workflows/test-runner.yml
[code-climate-url]: https://codeclimate.com/github/apimatic/requests-client-adapter
[maintainability-url]: https://api.codeclimate.com/v1/badges/1daeb05c58b9a252043c/maintainability
[test-coverage-url]: https://api.codeclimate.com/v1/badges/1daeb05c58b9a252043c/test_coverage
[license-badge]: https://img.shields.io/badge/licence-MIT-blue
[license-url]: LICENSE

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/apimatic/requests-client-adapter",
    "name": "apimatic-requests-client-adapter",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "APIMatic",
    "author_email": "support@apimatic.io",
    "download_url": "https://files.pythonhosted.org/packages/2e/7d/3f43bece4dbafad79fbee678d8447acf524fdad61575934dfb088ca52aaa/apimatic-requests-client-adapter-0.1.5.tar.gz",
    "platform": null,
    "description": "# apimatic-requests-client-adapter\n[![PyPI][pypi-version]][pypi-apimatic-requests-client-adapter-url]\n[![Tests][test-badge]][test-url]\n[![Test Coverage][test-coverage-url]][code-climate-url]\n[![Licence][license-badge]][license-url]\n\n## Introduction\nRequests is a simple, yet elegant, HTTP library. This repository contains the client implementation that uses the requests library for python SDK provided by APIMatic. \n\n## Version supported \nCurrenty APIMatic supports  `Python version 3.7 - 3.11`  hence the apimatic-requests-client-adapter will need the same versions to be supported.\n\n## Installation \nSimply run the command below in your SDK as the apimatic-requests-client-adapter will be added as a dependency in the SDK.\n```python\npip install apimatic-requests-client-adapter\n```\n**Supported Methods Provided by requests-client**\n\n| Method                                                                             | Description                                                                      |\n| -----------------------------------------------------------------------------------|----------------------------------------------------------------------------------|\n| [`create_default_http_client`](apimatic_requests_client_adapter/requests_client.py)| function to creat a defaultp http client                                         | \n| [`force_retries`](apimatic_requests_client_adapter/requests_client.py)             | Reset retries according to each request                                          | \n| [`execute`](apimatic_requests_client_adapter/requests_client.py)                   | Execute a given HttpRequest to get a string response back                        | \n| [`convert_response`](apimatic_requests_client_adapter/requests_client.py)          | Converts the Response object of the CoreHttpClient into a CoreHttpResponse object|\n\n## Tests\nThe requests client implementation also contains unit tests to ensure reliability of the implementation and to prevent unwanted breakages.\n\n## Links\n* [apimatic-core-interfaces](https://pypi.org/project/apimatic-core-interfaces/)\n* [Requests](https://pypi.org/project/requests/)\n\n[pypi-version]: https://img.shields.io/pypi/v/apimatic-requests-client-adapter\n[pypi-apimatic-requests-client-adapter-url]: https://pypi.org/project/apimatic-requests-client-adapter/\n[test-badge]: https://github.com/apimatic/requests-client-adapter/actions/workflows/test-runner.yml/badge.svg\n[test-url]: https://github.com/apimatic/requests-client-adapter/actions/workflows/test-runner.yml\n[code-climate-url]: https://codeclimate.com/github/apimatic/requests-client-adapter\n[maintainability-url]: https://api.codeclimate.com/v1/badges/1daeb05c58b9a252043c/maintainability\n[test-coverage-url]: https://api.codeclimate.com/v1/badges/1daeb05c58b9a252043c/test_coverage\n[license-badge]: https://img.shields.io/badge/licence-MIT-blue\n[license-url]: LICENSE\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An adapter for requests client library consumed by the SDKs generated with APIMatic",
    "version": "0.1.5",
    "project_urls": {
        "Homepage": "https://github.com/apimatic/requests-client-adapter"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9e612ae74ed236cd0132e1390055f1a67f1bec522d0f2b250221d009933998b2",
                "md5": "2b98c3dafe49868419ee0106335b2f2b",
                "sha256": "369fe47451846cdcffa7b6b7fce99b95206742851dcf21102d8e23fa932659ed"
            },
            "downloads": -1,
            "filename": "apimatic_requests_client_adapter-0.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2b98c3dafe49868419ee0106335b2f2b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 11125,
            "upload_time": "2023-08-09T09:53:01",
            "upload_time_iso_8601": "2023-08-09T09:53:01.391461Z",
            "url": "https://files.pythonhosted.org/packages/9e/61/2ae74ed236cd0132e1390055f1a67f1bec522d0f2b250221d009933998b2/apimatic_requests_client_adapter-0.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2e7d3f43bece4dbafad79fbee678d8447acf524fdad61575934dfb088ca52aaa",
                "md5": "971785f65337c024180ddd60c187b4a0",
                "sha256": "a2314091263fd14f1912ec52d4bf88abc84279a1c64ef4886d3f17ca6967c930"
            },
            "downloads": -1,
            "filename": "apimatic-requests-client-adapter-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "971785f65337c024180ddd60c187b4a0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7243,
            "upload_time": "2023-08-09T09:53:02",
            "upload_time_iso_8601": "2023-08-09T09:53:02.840264Z",
            "url": "https://files.pythonhosted.org/packages/2e/7d/3f43bece4dbafad79fbee678d8447acf524fdad61575934dfb088ca52aaa/apimatic-requests-client-adapter-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-09 09:53:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "apimatic",
    "github_project": "requests-client-adapter",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "lcname": "apimatic-requests-client-adapter"
}
        
Elapsed time: 0.57945s