https://github.com/aryathel/apiframework

A Python API framework for use as a base for the creation of API wrappers featuring strongly typed data structures through Pydantic.
https://github.com/aryathel/apiframework

api api-client api-client-python async python

Last synced: 3 months ago
JSON representation

A Python API framework for use as a base for the creation of API wrappers featuring strongly typed data structures through Pydantic.

• Host: GitHub
• URL: https://github.com/aryathel/apiframework
• Owner: Aryathel
• License: mit
• Created: 2022-06-05T09:03:38.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-01T02:33:41.000Z (almost 3 years ago)
• Last Synced: 2024-10-10T09:38:01.570Z (9 months ago)
• Topics: api, api-client, api-client-python, async, python
• Language: Python
• Homepage: https://apiframework.readthedocs.io/en/latest/
• Size: 470 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Arya's API Framework

====================

.. list-table::

    :stub-columns: 1

    :widths: 10 90

    * - Docs

      - |docs|

    * - PyPI

      - |pypi-version| |supported-versions| |supported-implementations| |wheel|

    * - Activity

      - |commits-latest| |maintained| |pypi-downloads|

    * - QA

      - |codefactor|

    * - Other

      - |license| |language|

.. |docs| image:: https://img.shields.io/readthedocs/apiframework/latest?logo=read-the-docs&color=8566D9&logoColor=white

    :target: https://apiframework.readthedocs.io/en/latest/

    :alt: RTFD - Docs Build Status

.. |pypi-version| image:: https://img.shields.io/pypi/v/arya-api-framework?color=8566D9

    :target: https://pypi.org/project/arya-api-framework/

    :alt: PyPI - Package Version

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/arya-api-framework?logo=python&logoColor=white&color=8566D9

    :target: https://pypi.org/project/arya-api-framework/

    :alt: PyPI - Supported Python Versions

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/arya-api-framework?color=8566D9

    :target: https://pypi.org/project/arya-api-framework/

    :alt: PyPI - Supported Implementations

.. |wheel| image:: https://img.shields.io/pypi/wheel/arya-api-framework?color=8566D9

    :target: https://pypi.org/project/arya-api-framework/

    :alt: PyPI - Wheel

.. |commits-latest| image:: https://img.shields.io/github/last-commit/Aryathel/ApiFramework/main?color=8566D9

    :target: https://github.com/Aryathel/APIFramework

    :alt: Github - Last Commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2022?color=8566D9

    :target: https://github.com/Aryathel/APIFramework/commit/main

    :alt: Maintenance

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/arya-api-framework?color=8566D9

    :target: https://pypistats.org/packages/arya-api-framework

    :alt: PyPI - Downloads

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/Aryathel/ApiFramework?logo=codefactor&color=8566D9&logoColor=white

    :target: https://www.codefactor.io/repository/github/Aryathel/ApiFramework

    :alt: CodeFactor - Grade

.. |license| image:: https://img.shields.io/github/license/Aryathel/ApiFramework?color=8566D9

    :target: https://github.com/Aryathel/ApiFramework/blob/main/LICENSE

    :alt: GitHub - License

.. |language| image:: https://img.shields.io/github/languages/top/Aryathel/ApiFramework?color=8566D9

    :target: https://github.com/Aryathel/ApiFramework

    :alt: GitHub - Top Language

This is a simple package that is meant to be a

`Pydantic `__ implementation

for a basic RESTful API interaction client. This includes both sync and async usages.

Installation

------------

Synchronous implementation - if you aren't sure, you probably want this:

.. code-block:: sh

    python -m pip install arya-api-framework[sync]

Asynchronous implementation:

.. code-block:: sh

    python -m pip install arya-api-framework[async]

Documentation

-------------

https://apiframework.readthedocs.io/en/latest/

TODO Features

-------------

https://apiframework.readthedocs.io/en/latest/#todo-features

Citation

--------

Credit for documentation infrastructure goes to `Rapptz `_ and the

`discord.py `_ team. The documentation for this project is a modified version of

their custom theme.