add README

.gitignore

@@ -1,2 +1,6 @@
-__pycache__
+.idea/
 .pytest_cache
+__pycache__
+aiohttp_pydantic.egg-info/
+build/
+dist/

README.rst

@@ -0,0 +1,73 @@
+Aiohttp pydantic - Aiohttp View to validate and parse request
+=============================================================
+
+How to install
+--------------
+
+.. code-block:: bash
+
+    $ pip install aiohttp_pydantic
+
+
+Example:
+--------
+
+.. code-block:: python3
+
+    from typing import Optional
+
+    from aiohttp import web
+    from aiohttp_pydantic import PydanticView
+    from pydantic import BaseModel
+
+    # Use pydantic BaseModel to validate request body
+    class ArticleModel(BaseModel):
+        name: str
+        nb_page: Optional[int]
+
+
+    # Create your PydanticView and add annotations.
+    class ArticleView(PydanticView):
+
+        async def post(self, article: ArticleModel):
+            return web.json_response({'name': article.name,
+                                      'number_of_page': article.nb_page})
+
+        async def get(self, with_comments: Optional[bool]):
+            return web.json_response({'with_comments': with_comments})
+
+
+    app = web.Application()
+    app.router.add_view('/article', ArticleView)
+    web.run_app(app)
+
+
+.. code-block:: bash
+
+    $ curl -X GET http://127.0.0.1:8080/article?with_comments=a
+    [
+      {
+        "loc": [
+          "with_comments"
+        ],
+        "msg": "value could not be parsed to a boolean",
+        "type": "type_error.bool"
+      }
+    ]
+
+    $ curl -X GET http://127.0.0.1:8080/article?with_comments=yes
+    {"with_comments": true}
+
+    $ curl -H "Content-Type: application/json" -X post http://127.0.0.1:8080/article --data '{}'
+    [
+      {
+        "loc": [
+          "name"
+        ],
+        "msg": "field required",
+        "type": "value_error.missing"
+      }
+    ]
+
+    $ curl -H "Content-Type: application/json" -X post http://127.0.0.1:8080/article --data '{"name": "toto", "nb_page": "3"}'
+    {"name": "toto", "number_of_page": 3}