Skip to main content

A generic python REST client

Project description

qrest is a Python package that allows you to easily build a Python client to access a REST API. To show how it works, we use it to access the REST API of the JSONPlaceholder website, which provides dummy data for testing and prototyping purposes.

The following Python snippet sends a HTTP GET request to retrieve all “posts”, which is one of the resources of the website:

import pprint
import requests

response = requests.request("GET", "https://jsonplaceholder.typicode.com/posts")
pprint.pprint(response.json()[0:2])

This snippet outputs:

[{'body': 'quia et suscipit\n'
          'suscipit recusandae consequuntur expedita et cum\n'
          'reprehenderit molestiae ut ut quas totam\n'
          'nostrum rerum est autem sunt rem eveniet architecto',
 'id': 1,
 'title': 'sunt aut facere repellat provident occaecati excepturi optio '
          'reprehenderit',
 'userId': 1},
{'body': 'est rerum tempore vitae\n'
         'sequi sint nihil reprehenderit dolor beatae ea dolores neque\n'
         'fugiat blanditiis voluptate porro vel nihil molestiae ut '
         'reiciendis\n'
         'qui aperiam non debitis possimus qui neque nisi nulla',
 'id': 2,
 'title': 'qui est esse',
 'userId': 1}]

The snippet uses the Python requests library to send the request. This library makes it very easy to query a REST API, but it requires the user to know the structure of the REST API, how to build calls to that API, how to parse responses etc. This is where qrest comes in: it allows you to configure a Python API that provides access to the information and hides the nitty-gritty details of writing REST API code. For example, using qrest the code to retrieve the posts looks like this:

import qrest
import jsonplaceholderconfig

api = qrest.API(jsonplaceholderconfig)

posts = api.all_posts()

If you want to retrieve the posts from a specific author:

import pprint

# all authors are numbered from 1 to 10
posts = api.filter_posts(user_id=7)

# only output the title of each post for brevity
titles = [post["title"] for post in posts]
pprint.pprint(titles)

which outputs:

['voluptatem doloribus consectetur est ut ducimus',
 'beatae enim quia vel',
 'voluptas blanditiis repellendus animi ducimus error sapiente et suscipit',
 'et fugit quas eum in in aperiam quod',
 'consequatur id enim sunt et et',
 'repudiandae ea animi iusto',
 'aliquid eos sed fuga est maxime repellendus',
 'odio quis facere architecto reiciendis optio',
 'fugiat quod pariatur odit minima',
 'voluptatem laborum magni']

The one thing you have to do is configure this API. The module jsonplaceholderconfig in the example above is configured like this:

from qrest import APIConfig, ResourceConfig, QueryParameter


class JSONPlaceholderConfig(APIConfig):
    url = "https://jsonplaceholder.typicode.com"


class AllPosts(ResourceConfig):

    name = "all_posts"
    path = ["posts"]
    method = "GET"
    description = "retrieve all posts"


class FilterPosts(ResourceConfig):

    name = "filter_posts"
    path = ["posts"]
    method = "GET"
    description = "retrieve all posts with a given title"

    user_id = QueryParameter(name="userId", description="the user ID of the author of the post")

For more information about qrest and its usage, we refer to the documentation.

If you want to contribute to qrest itself, we refer to the developer README that is located in the root directory of the repo.

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

qrest-4.2.2.tar.gz (36.9 kB view details)

Uploaded Source

Built Distribution

qrest-4.2.2-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

Details for the file qrest-4.2.2.tar.gz.

File metadata

  • Download URL: qrest-4.2.2.tar.gz
  • Upload date:
  • Size: 36.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for qrest-4.2.2.tar.gz
Algorithm Hash digest
SHA256 62a874e0fc7f5ce54ea97bd7b743dff84f223bf61b60cc03a77bb412c55b820e
MD5 8746ef9e2b539cc075ea7ec6d2c79100
BLAKE2b-256 247b0ae06faddc8a01a97f98f09f75e0c564a5c360147a278265c48b34ff21fc

See more details on using hashes here.

File details

Details for the file qrest-4.2.2-py3-none-any.whl.

File metadata

  • Download URL: qrest-4.2.2-py3-none-any.whl
  • Upload date:
  • Size: 37.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for qrest-4.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 90ad89caf2b7fe43dbfccebe7e2e00b9b86d0b683c7a08f66a078ce7f6f84f3b
MD5 7828dba0f40383925345800c6243068d
BLAKE2b-256 177d3afd8328df5c85e3df5e4eb18b8cd88428e0c859221ef2f5de0ae558cbda

See more details on using hashes here.

Supported by

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