https://github.com/apimatic/requests-client-adapter
This repository contains the client implementation that uses the requests library for python SDK.
https://github.com/apimatic/requests-client-adapter
Last synced: about 1 year ago
JSON representation
This repository contains the client implementation that uses the requests library for python SDK.
- Host: GitHub
- URL: https://github.com/apimatic/requests-client-adapter
- Owner: apimatic
- License: mit
- Created: 2022-08-29T12:11:13.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-01T22:06:45.000Z (over 1 year ago)
- Last Synced: 2025-03-24T15:52:32.450Z (over 1 year ago)
- Language: Python
- Size: 81.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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+` 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