Arya’s API Framework

Docs
PyPI
Activity
QA
Other

This module is designed to be a base for the creation of clients that interact with RESTful web APIs.

Features:

• Synchronous branch utilizing requests.

• Asynchronous branch utilizing aiohttp.

• Integrated with pydantic for strict typing.

Disclaimer

This library is not intended for fast, performant code. It is instead optimized for user-friendliness and strict data typing. While this will likely not be a noticeable issue for many users, please keep this in mind.

Installation

To install the sync branch:

pip install arya-api-framework[sync]

To install the async branch:

pip install arya-api-framework[async]

Getting Started

• Quickstart
• Closing Thoughts
• Logging

API Reference

• Sync Client
• Async Client
• Data Models
  • Basic Models
  • Response Models
• Utility Functions
• Exceptions
  • General Exceptions
  • Client Exceptions
  • Request Exceptions
  • Exception Hierarchy

Information

Here lies a bunch of random information related to the project at least a little bit.

• Web Information
  • Terminology
  • HTTP Request Methods
  • HTTP Status Codes
  • Reference

Glossary

If you are struggling to find specific information, see these references:

• Search

• Glossary

TODO Features

• Rate Limits (Allow rate limit application for limited APIs.)
• Response Caching (Reduce processing times/network load.)
• Sub-Clients (For creating API category modules.)