No project description provided
Project description
Presto! Requests
An object-oriented REST API client & requests extesion library.
Installation
pip install presto-requests
poetry add presto-requests
Concept:
Presto! Requests is a library that extends the functionality of the requests library. It provides a simple way to create a REST API client that is object-oriented and easy to use.
Example:
from pprint import pprint
from presto import Presto
presto = Presto("https://api.github.com")
user = presto.users.sitbon() # == presto.users["sitbon"]()
print(f"User {user.attr.login} has {user.attr.public_repos} public repositories.")
pprint(user.json())
User sitbon has 15 public repositories.
{'avatar_url': 'https://avatars.githubusercontent.com/u/1381063?v=4',
'bio': None,
'blog': '',
'company': None,
'created_at': '2012-01-26T04:25:21Z',
'email': None,
'events_url': 'https://api.github.com/users/sitbon/events{/privacy}',
'followers': 7,
'followers_url': 'https://api.github.com/users/sitbon/followers',
'following': 13,
'following_url': 'https://api.github.com/users/sitbon/following{/other_user}',
'gists_url': 'https://api.github.com/users/sitbon/gists{/gist_id}',
'gravatar_id': '',
'hireable': None,
'html_url': 'https://github.com/sitbon',
'id': 1381063,
'location': 'Portland, OR, USA',
'login': 'sitbon',
'name': 'Phillip Sitbon',
'node_id': 'MDQ6VXNlcjEzODEwNjM=',
'organizations_url': 'https://api.github.com/users/sitbon/orgs',
'public_gists': 4,
'public_repos': 15,
'received_events_url': 'https://api.github.com/users/sitbon/received_events',
'repos_url': 'https://api.github.com/users/sitbon/repos',
'site_admin': False,
'starred_url': 'https://api.github.com/users/sitbon/starred{/owner}{/repo}',
'subscriptions_url': 'https://api.github.com/users/sitbon/subscriptions',
'twitter_username': None,
'type': 'User',
'updated_at': '2022-11-22T00:41:18Z',
'url': 'https://api.github.com/users/sitbon'}
Usage:
Each dot in the path of the request is a new request object.
Calling the object without any arguments will execute the request and return the response object.
Specifying keyword arguments will add them to the request as keyword arguments to requests.request(), and then return the current object for further chaining.
There are a few special top-level attributes that can be used to modify the request:
get
, post
, put
, patch
, delete
, head
, options
, and finally request
which is
an empty path component that can be used to indirectly modify existing top-level auto created request objects.
All of these top-level attributes are able to clone existing request attributes, to modify the path and parent parameters while using the same component path and parameters.
For example:
from presto import Presto
presto = Presto("http://127.0.0.1:8000", APPEND_SLASH=True)
api = presto.api
print("api:", api)
print("presto.request.api:", presto.request.api)
print("equal:", presto.request.api == api)
api(headers={"X-User": "Testing"})(allow_redirects=False)
print("api(...):", api)
resp = api.note[4]()
print("req headers:", resp.request.headers)
print("resp:", resp)
print("note:", resp.attr)
api: Presto(url='http://127.0.0.1:8000/', params=adict(method='GET', headers=adict(Accept='application/json'))).Request(path='/api/')
presto.request.api: Presto(url='http://127.0.0.1:8000/', params=adict(method='GET', headers=adict(Accept='application/json'))).Request(path='/').Request(path='/api/')
equal: True
api(...): Presto(url='http://127.0.0.1:8000/', params=adict(method='GET', headers=adict(Accept='application/json'))).Request(path='/api/', params=adict(headers={'X-User': 'Testing'}, allow_redirects=False))
req headers: {'User-Agent': 'python-requests/2.28.1', 'Accept-Encoding': 'gzip, deflate', 'Accept': 'application/json', 'Connection': 'keep-alive', 'X-User': 'Testing'}
resp: <Response [200]>
note: adict(id=4, url='http://127.0.0.1:8000/api/note/4/', time='2022-26-02T19:26:09-0800', note='Hello from the API!!', collection='http://127.0.0.1:8000/api/coll/3/')
response.attr
is an adict
instance, which is a dictionary that can be accessed as attributes.
It contains the JSON-decoded content of a response, if any.
APPEND_SLASH
is meant to be globally implementation-specific, e.g. for Django Rest Framework you would
set Presto.APPEND_SLASH = True
to append a trailing slash to all requests without specifying it every time.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for presto_requests-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 816cf6033fb852341cb3857c4b4f50fc2087b1efb230fcee94411672ac799ca5 |
|
MD5 | 97b77aed09c6ac67e7b248c12604f2a4 |
|
BLAKE2b-256 | fd7033502338c47ad61597b85d2c5084c92ba6775e263c4ff2f5668b42d0dd84 |