From 7d0d6d7dc32f55343f97b5ef90e4327d2d67e674 Mon Sep 17 00:00:00 2001 From: Muhammad Rafay Nadeem <113093783+mrafnadeem-apimatic@users.noreply.github.com> Date: Thu, 2 Jan 2025 12:34:05 +0500 Subject: [PATCH] docs: compatibility with python 3.12 and 3.13 (#42) --- .github/workflows/pylint.yml | 4 ++-- .github/workflows/test-runner.yml | 4 ++-- README.md | 14 +++++++------- requirements.txt | 1 + 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml index e9cd077..a53b951 100644 --- a/.github/workflows/pylint.yml +++ b/.github/workflows/pylint.yml @@ -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 @@ -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 diff --git a/.github/workflows/test-runner.yml b/.github/workflows/test-runner.yml index 783866f..465fbb4 100644 --- a/.github/workflows/test-runner.yml +++ b/.github/workflows/test-runner.yml @@ -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 @@ -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 }} diff --git a/README.md b/README.md index 267c331..ca65c6c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/requirements.txt b/requirements.txt index 83b3b98..1933509 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ apimatic-core-interfaces~=0.1.0 requests~=2.31 cachecontrol~=0.12.6 +setuptools>=68.0.0 \ No newline at end of file