requests-rest-api 0.2.4

The requests-rest-api package contains functions to make REST API calls using the requests package.

Requests REST API

---

Table of Contents

• Introduction
• Examples
• Development
• Installation
• License

Introduction

The requests-rest-api package contains functions to make REST API calls, it is build on top of the requests library. Inspiration was found in a similar package by Deric Degagne

Examples

Simple GET:

from requests_rest_api.rest_api import get_request

get_request("https://reqres.in/api/users/2")

---

NOTE

All the functions simply pass all parameters to requests, so if you can always add more parameters if needed. For example add the headers parameter like this:

from requests_rest_api.rest_api import get_request

get_request("https://reqres.in/api/users/2", headers={"Token": "123"})

---

Example with a Session

requests has a Session class that can take care of connection-pooling, authorisation, headers, cookies etc. It is a good idea to use this if you need to make multiple calls to the same endpoints.

This example would set a token for the session:

from requests import Session
from requests_rest_api.rest_api import get_request

with Session(headers={"Token": "123"}) as session:
    result = get_request("https://reqres.in/api/users/2", session=session)

Development

Pytest and Hatch are used to make our lives as developers great.

Installation

pip install requests-rest-api

License

requests-rest-api is distributed under the terms of the MIT license.