Welcome to aiorequestful!

An Asynchronous HTTP and RESTful API requests framework for asyncio and Python

• Full implementation of authorisation handling for authorising with any HTTP service, including OAuth2 flows

• Automatic response payload caching and cache retrieval on a per-endpoint basis to allow fine control over how and when response data is cached

• Automatic payload response handling to transform responses before returning and caching

• Automatic handling of common HTTP error status codes to ensure guaranteed successful requests

• Formulaic approach to retries and backoff handling to ensure smooth requests on sensitive services to handle ‘Too Many Requests’ style errors

What’s in this documentation

• Guides on getting started with aiorequestful and other key functionality of the package

• Release history

• How to get started with contributing to aiorequestful

• Reference documentation

Installation

Install through pip using one of the following commands:

pip install aiorequestful
# or
python -m pip install aiorequestful

This package has various optional dependencies for optional functionality. Should you wish to take advantage of some or all of this functionality, install the optional dependencies as follows:

pip install aiorequestful[all]  # installs all optional dependencies

pip install aiorequestful[sqlite]  # dependencies for working with a SQLite cache backend

# or you may install any combination of these e.g.
pip install aiorequestful[sqlite,test]

📜 Guides & Getting Started

• Installation
• Sending requests
• Handling payload data
• Handling error responses
• Authorising requests
• Caching responses
• Timers

🛠️ Project Info

• Release History
• Contributing
• Licence

📖 Reference

• Auth
• Cache
• Request
• Response
• Exceptions
• Timer
• Types

---

• Index