Several fixes and documentation

Author: FalseDev

README.md

@@ -0,0 +1 @@
+docs/index.md

README.md

@@ -10,7 +10,13 @@
 
 
 class BaseRouter:
-    def _initialize(self):
+    """Base class implementing 'route mounting' functionality"""
+    def _initialize(self, **kwargs):
+        """Looks for routers and routes and mount them
+
+        Also handles calling the _pre_init and _post_init hooks
+        """
+        self._pre_init()
         self_is_router = isinstance(self, APIRouter)
         client = self.client if self_is_router else self
         for attr_name, attr_type in getattr(self, '__annotations__', {}).items():
@@ -21,11 +27,14 @@ def _initialize(self):
             attr = getattr(self, attr_name)
             if isinstance(attr, Endpoint):
                 attr.register(router=self)
-        self._post_init()
+        self._post_init(**kwargs)
+
+    def _pre_init(self):
+        pass
 
     def _post_init(self, **kwargs):
         if kwargs:
-            raise RuntimeError("Unexpected arguments passed!")
+            raise RuntimeError("Unexpected argument {} passed!".format(next(iter(kwargs.keys()))))
 
 
 class APIClient(BaseRouter):
@@ -48,6 +57,7 @@ class APIRouter(BaseRouter):
     def __init__(self, client: APIClient):
         self.client = client
         self.session = client.session
+        self.base_url = client.base_url
         self._post_processors = []
         self._initialize()
 
@@ -76,16 +86,18 @@ def register(self, *, router: APIRouter):
     def __call__(self, *args, **kwargs):
         request = self.callback(self.router, *args, **kwargs)
 
-        httpx_request = self.session.build_request(**request.dict())
+        httpx_request = self.session.build_request(**request.dict(router=self.router))
 
         if inspect.iscoroutinefunction(self.session.send):
             return self.async_call(httpx_request)
         return self.sync_call(httpx_request)
 
     def sync_call(self, httpx_request):
         response = self.session.send(httpx_request)
+        print(self.post_processors, response)
         for post_processor in self.post_processors:
             response = post_processor(response)
+            print(response)
         return response
 
     async def async_call(self, httpx_request):

apiclient/core.py

@@ -30,9 +30,9 @@ def dict(self, *, router: APIRouter):
         if self.absolute_url:
             url = self.url
         elif self.from_base_url:
-            url = router.client.base_url + self.url
+            url = router.base_url + self.url
         else:
-            url = router.client.base_url + router.path + self.url
+            url = router.base_url + getattr(router, 'path', '') + self.url
         req_dict['url'] = url
 
         return req_dict

apiclient/methods.py

@@ -0,0 +1,33 @@
+# Introduction
+
+If you've ever tried to make an API wrapper
+you probably know that the code written can
+only be used as sync or async, well, not anymore.
+
+## Features
+
+- **Lightweight**: Extremely lightweight and minimal
+- **Easy to use**: Implement features in no time with the
+- **Async and blocking**: Provides both async and blocking calls
+- **Test without a server**: Since the library internally uses httpx, it can be used to test itself using an `ASGI` or `WSGI` application.
+- **DRY**: _Don't repeat yourself_, helps avoid code duplication and write reusable code
+- **Routing**: An `APIRouter` class with simliar API to `APIClient`
+- **Modular**: Create reusable routers that can be added to any client, independant of each other
+
+## Example Usage
+
+```py
+
+from apiclient import APIClient, endpoint, Post
+
+class CodeExecClient(APIClient):
+  base_url = "https://pathtomysite.com/api/1.0"   # Note the missing / suffix
+  @endpoint
+  def run(self, language:str, code:str):
+    # Do any processing with the data here!
+    # Also note the / prefix in the url
+    return Post("/execute", params={'lang':language, 'code':code})
+
+```
+
+## Documentation is under works

docs/index.md

@@ -0,0 +1,24 @@
+site_name: Instant API Client
+site_description: Create API wrappers/clients in minutes, enjoying both blocking and async interfaces from one codebase!
+
+theme:
+  name: material
+  palette:
+    scheme: slate
+    primary: teal
+    accent: purple
+
+
+markdown_extensions:
+  - pymdownx.highlight
+  - pymdownx.superfences
+
+
+plugins:
+  - search
+  - mkdocstrings:
+      handler: python
+
+nav:
+  - Introduction: index.md
+