Skip to content
This repository was archived by the owner on Jun 29, 2022. It is now read-only.

Commit ecc5fab

Browse files
committed
update readme
1 parent d1bd56f commit ecc5fab

File tree

3 files changed

+23
-1
lines changed

3 files changed

+23
-1
lines changed

README.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ aioCloudflare
3232
:target: https://github.com/psf/black
3333
:alt: Black
3434

35+
Inspired by the offical `python-cloudflare` library developed by `Cloudflare`_. This project is created to be competible to use with `asyncio` for non-blocking IO.
36+
37+
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.
38+
39+
*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.
40+
41+
Having said that, do submit an issue if you encounter any bug so we can move away from the Alpha stage sooner.
3542

3643
Features
3744
--------
@@ -68,6 +75,17 @@ Usage
6875
async with Cloudflare() as cf:
6976
result = await cf.zones.get()
7077
78+
Full configuration can be done using `Config()` class.
79+
80+
.. code:: Python
81+
82+
from aioCloudflare import Cloudflare, Config
83+
84+
config = Config(email="[email protected]", token="<secret>")
85+
async def get_zone():
86+
async with Cloudflare(config=config) as cf:
87+
result = await cf.zones.get()
88+
7189
7290
Contributing
7391
------------
@@ -96,3 +114,4 @@ please `file an issue`_ along with a detailed description.
96114
.. _pip: https://pip.pypa.io/
97115
.. github-only
98116
.. _Contributor Guide: CONTRIBUTING.rst
117+
.. _Cloudflare: https://cloudflare.com

aiocloudflare/__init__.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
from .cloudflare import Cloudflare # noqa
1+
from .cloudflare import Cloudflare
2+
from .commons.config import Config
3+
4+
__all__ = ["Cloudflare", "Config"]

aiocloudflare/py.typed

Whitespace-only changes.

0 commit comments

Comments
 (0)