README.rst

aionap - Python Asyncio REST Client

aionap is a Python asyncio enabled REST client. It uses a similar API like slumber and copies shameless other parts of it.

Feel free to contribute via pull requests, issues or email messages.

QuickStart

1. Install aionap:

   $ pip install aionap
   

2. Install Optional Requirement:

   pip install pyyaml
   

3. Use it!

Usage

• Get an API object and fetch a url/resource (e.g. https://demo.api-platform.com/books)

import aionap
async with aionap.API('https://demo.api-platform.com') as api
    response = await api.books.get()

For more see the documenation, the test/test_demo_api.py file or the example directory.

Installation

aionap is available via PyPI, just install it as usual.

$ pip install aionap

aionap requires Python >= 3.6.

[OPTIONAL] PyYaml (Required for the yaml serializer):

$ pip install pyyaml

Features

• Basic Auth support
• JSON, YAML serializers
• GET, POST, PUT, PATCH, DELETE of resources
• Good test coverage

TODO

• OAuth support
• Readthedocs API documentation (SSL_CERT_FILE)

Compatibility

Python >= 3.6

Licence

BSD 2-Clause License

Authors and Contributors

• Christian Assing (Main author)