Merge pull request #21 from Stewart86/beta-2

Beta 2 release

Author: Stewart86

README.rst

@@ -57,7 +57,9 @@ Feature Roadmap
 
 * to support cert token
 * to support sync API client
-* to get to 100% test coverage
+
+These are some alternative use cases that are not in the top of my priority now as I have not received
+any request for. If you are interested, you may want to submit a pull request to contribute some of these features.
 
 
 Requirements
@@ -85,20 +87,46 @@ Usage
 
     async def get_zone():
         async with Cloudflare() as cf:
-            result = await cf.zones.get()
+            response = await cf.zones.get()
 
-Full configuration can be done using `Config()` class.
+Unlike the offical ``python-cloudflare`` library, ``aiocloudflare`` does not parse and handle http responses.
+
+So the awaited response object will have to be handled just as any http request, response pattern. the ``Response`` object is the same as ``httpx``'s ``Response``.
+
+.. code:: Python
+
+    from aiocloudflare import Cloudflare
+
+    async def get_zone():
+        async with Cloudflare() as cf:
+            response = await cf.zones.get()
+
+            # check status code
+            if response.status_code == 200:
+
+                # get json data
+                resp_json = response.json()
+
+                # Cloudflare API typically store results in a ``result`` key.
+                return resp_json["result"]
+
+            else:
+                # to get texture data from response
+                print(response.text)
+
+
+Full configuration can be done using ``Config()`` class.
 
 .. code:: Python
 
     from aioCloudflare import Cloudflare, Config
 
-    config = Config(email="[email protected]", token="<secret>")
+    config = Config(email="[email protected]", token="<secret>")  # for demo only, do not hardcode secrets
     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:
+Configuration can also be stored in a ``.env`` file for a "global" configuration without needing to create a ``Config()`` class. Keys available are:
 
 .. code:: console
 
@@ -110,6 +138,31 @@ Configuration can also be stored in a ``.env`` file for a "global configuration
     CF_PROFILE=""
     USER_AGENT=""
 
+Advance Usage
+_____________
+
+You may wish to wrap ``Cloudflare()`` into you own class for customised settings or requirements. To do that, just provide a ``__aenter__()`` and ``__aexit__()`` method to your class like so.
+
+.. code:: Python
+
+    class MyCfClient:
+        def __init__(self):
+            self._config = Config(email="[email protected]", token="<secret>")  # for demo only, do not hardcode secrets
+
+        async def __aenter__(self):
+            self._client = Cloudflare(config=self._config)
+            return self
+
+        async def __aexit__(self, exc_type, exc_value, traceback):
+            await self._client.aclose()
+
+Then you can call your own class with async context manager.
+
+.. code:: Python
+
+    async with MyCfClient() as own_class:
+        await own_class.zones.get()
+
 
 Contributing
 ------------

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "aiocloudflare"
-version = "0.2.0-beta-1"
+version = "0.2.0-beta-2"
 description = "A Cloudflare API wrapper for Python with asyncio support"
 authors = ["Stewart Wong <[email protected]>"]
 license = "MIT"