aiocloudflare 0.1.3a0

A Cloudflare API wrapper for Python with asyncio support

Inspired by the offical python-cloudflare library developed by Cloudflare. This project is created to be compatible with asyncio for non-blocking IO.

For sync code, it is recommanded to use python-cloudflare via pip install python-cloudflare as it is used by hundreds and offically maintained by Cloudflare. This ensure that APIs are always updated according to Cloudflare API release.

NOTE: This library is in Pre-Alpha, this means things might break. Do not use it in Production unless you have tested on the API route specific to your use case and that would be at your own risk.

Having said that, do submit an issue if you encounter any bug so we can move away from the Alpha stage sooner.

Features

• async http API call using modern http library httpx.

• Autocompletion on IDE.

• Fully type hinted.

Feature Roadmap

• to support cert token

• to support sync API client

• to get to 100% test coverage

Requirements

• Python 3.9+

Installation

You can install aiocloudflare via pip from PyPI:

$ pip install aiocloudflare

Usage

from aiocloudflare import Cloudflare

async def get_zone():
    async with Cloudflare() as cf:
        result = await cf.zones.get()

Full configuration can be done using Config() class.

from aioCloudflare import Cloudflare, Config

config = Config(email="[e-mail]", token="<secret>")
async def get_zone():
    async with Cloudflare(config=config) as cf:
        result = await cf.zones.get()

Configuration can also be stored in a .env file for a “global configuration without needing to create a Config() class. Keys available are:

CF_API_EMAIL=""
CF_API_KEY=""
CF_API_CERTKEY=""
CF_API_URL=""
DEBUG=false
CF_PROFILE=""
USER_AGENT=""

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Hello World is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.