Skip to main content

Python class that allow to create client for REST API with dynamic code generation

Project description

FitRequest

This module allows you to write REST api client with automatic code generation.

Skillcorner Coverage Build PyPI - Version Versions License

Example of implementation: SkillCorner Python client for SkillCorner API.

Help

See documentation for more details.

Installation

pip install fitrequest

A simple example

from fitrequest.client import FitRequest


class RestApiClient(FitRequest):
    base_url = "http://base_api_url"
    base_client_name="rest_api"
    _docstring_template = 'GET request on endpoint: {endpoint}\nDocs URL anchor: http://base_api_url/docs/{docs_url_anchor}'
    _methods_binding = [
        {
            'name': 'get_item',
            'endpoint': '/items/{}',
            'docs_url_anchor': 'items/items_list',
            'resource_name': 'item_id',
        }
    ]

This is a simple definition of a subclass of FitRequest object. By instanciating this class, we can do the following:

my_client = RestApiClient()
response = my_client.get_item(item_id=3)

response variable will hold the value of the JSON response of the following HTTP request:

GET http://base_api_url/items/3

Subclass definition

MethodDetails and methods_binding

MethodDetails is a dataclass that holds the following attributes:

  • name: the name of the method that will be created in the subclass of FitRequest
  • endpoint: the endpoint of the request
  • docstring: the docstring of the method that will be created in the subclass of FitRequest
  • exec_method: the name of the method that will be executed to retrieve the response
  • extra_params: the list of named arguments to add to the method signature
  • raise_for_status: wether to raise exception for response status code >= 400 and < 600
  • response_key: the key of the JSON response that will be returned by the method
  • resource_name: the name of the arg that will be used in the definition of the python method and sent as a path or query parameter in the request

_methods_binding is almost a list of MethodDetails (as dict) that will be used to create the methods in the subclass of FitRequest.

The methods can be extended with a docstring template in which you can use any other method attribute. You can also have all the methods starting with 'get' duplicated as a save method starting with 'get_and_save' taking a filepath argument and dumping the data into a file.

For the moment, the generation of methods supports only one query or path parameters. If an endpoint requires more variables in its definition, you will need to actually write the method. For example, it is not possible to send a request to the following endpoint with the current version of FitRequest:

GET http://base_api_url/path/to/resource/{resource_id}/subresource/{subresource_id}

It will be a topic for a future release.

_build_final_url method

This method is used to build the final url of the request. Sometimes, you may need to add some extra information in the url before making the query. For example, you may need to add a token in the url. Here is a simple example:

    def _build_final_url(self, endpoint: str, **kwargs) -> str:
            return f'{self.base_url}{endpoint}?token={self.token}'

Authentication

Basic authentication

Basic authentication is supported by FitRequest. You just need to override the following method to your subclass of FitRequest:

from requests.auth import HTTPBasicAuth

    def _authenticate(self) -> HTTPBasicAuth:
        return HTTPBasicAuth(self.username, self.password)

This will set the auth attribute of the request's session.

Header based authentication

Some API requires extra headers to be set in the request. If you need to do so, you will have to override the session property in your subclass of FitRequest:

from requests import Session

    @property
    def session(self) -> Session:
        session = super().session
        session.headers['APIKey'] = self.api_key
        return session

Contact

You can contact Skillcorner Team at: support@skillcorner.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fitrequest-0.3.1.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

fitrequest-0.3.1-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file fitrequest-0.3.1.tar.gz.

File metadata

  • Download URL: fitrequest-0.3.1.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.0 Linux/5.10.209-198.812.amzn2.x86_64

File hashes

Hashes for fitrequest-0.3.1.tar.gz
Algorithm Hash digest
SHA256 8247684022e792a0138316376451ed504944132274f9a21d2c19666196900fef
MD5 0cd83e91550abe031e93c471f3d70ce3
BLAKE2b-256 df0116de2260cb3aa1c6d11b327c4c981ee0226f64a7d1ad9af366a0f5d69ce9

See more details on using hashes here.

File details

Details for the file fitrequest-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: fitrequest-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.0 Linux/5.10.209-198.812.amzn2.x86_64

File hashes

Hashes for fitrequest-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f06bdcb4f6fddc355f56d4b6a65f99dc81ec38cb725e7c70afdd1ce404e1327a
MD5 19aeea52a1455953d0ae9c4f1a38fefc
BLAKE2b-256 8383142a1ec17cc481dbd6c7475ae3a658e44cc783151b2d96e5a4c48af81830

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page