apimatic-requests-client-adapter 0.1.10
An adapter for requests client library consumed by the SDKs generated with APIMatic
License: MIT

# apimatic-requests-client-adapter
[![PyPI][pypi-version]][pypi-apimatic-requests-client-adapter-url]
[![Tests][test-badge]][test-url]
[![Test Coverage][coverage-badge]][coverage-url]
[![Maintainability Rating][maintainability-badge]][maintainability-url]
[![Vulnerabilities][vulnerabilities-badge]][vulnerabilities-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+`  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
[coverage-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_requests-client-adapter&metric=coverage
[coverage-url]: https://sonarcloud.io/summary/new_code?id=apimatic_requests-client-adapter
[maintainability-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_requests-client-adapter&metric=sqale_rating
[maintainability-url]: https://sonarcloud.io/summary/new_code?id=apimatic_requests-client-adapter
[vulnerabilities-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_requests-client-adapter&metric=vulnerabilities
[vulnerabilities-url]: https://sonarcloud.io/summary/new_code?id=apimatic_requests-client-adapter
[license-badge]: https://img.shields.io/badge/licence-MIT-blue
[license-url]: LICENSE