Skip to content

Commit

Permalink
docs: compatibility with python 3.12 and 3.13 (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrafnadeem-apimatic authored Jan 2, 2025
1 parent e92484a commit 7d0d6d7
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/pylint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-latest]
python: ["3.7", "3.8", "3.9", "3.10", "3.11"]
python: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
steps:
- uses: actions/checkout@v3
- name: Setup Python
Expand All @@ -40,5 +40,5 @@ jobs:
run: |
for file in $(find -name '*.py')
do
pylint --disable=R,C,W "$file" --fail-under=10;
pylint --disable=R,C,W "$file" --fail-under=10;
done
4 changes: 2 additions & 2 deletions .github/workflows/test-runner.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
python: ["3.7", "3.8", "3.9", "3.10", "3.11"]
python: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
steps:
- uses: actions/checkout@v3
- name: Setup Python
Expand All @@ -33,7 +33,7 @@ jobs:
- name: Generate coverage report
run: coverage xml
- name: Upload coverage report
if: ${{ matrix.os == 'ubuntu-latest' && matrix.python == '3.11' && github.actor != 'dependabot[bot]' }}
if: ${{ matrix.os == 'ubuntu-latest' && matrix.python == '3.13' && github.actor != 'dependabot[bot]' }}
uses: paambaati/codeclimate-action@v3.0.0
env:
CC_TEST_REPORTER_ID: ${{ secrets.CODE_CLIMATE_TEST_REPORTER_ID }}
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
[![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.
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.
## Version supported
Currenty APIMatic supports `Python version 3.7+` hence the apimatic-requests-client-adapter will need the same versions to be supported.

## Installation
## 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
Expand All @@ -19,9 +19,9 @@ pip install apimatic-requests-client-adapter

| 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 |
| [`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
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
apimatic-core-interfaces~=0.1.0
requests~=2.31
cachecontrol~=0.12.6
setuptools>=68.0.0

0 comments on commit 7d0d6d7

Please sign in to comment.