Documentation update

Author: macisamuele

CHANGELOG-MASTER.rst

@@ -8,4 +8,5 @@ Changelog-Master
 X.X.X (XXXX-XX-XX)
 ------------------
 - Add API key authentication via header to RequestsClient
+- Fido client is an optional dependency. **NOTE**: if you intend to use bravado with fido client you need to install bravado with fido extras (``pip install bravado[fido]``)
 - PLACEHOLDER (add before this line your modifications summary)

README.rst

@@ -37,7 +37,7 @@ however Bravado aims to be a complete replacement for code generation
 Example Usage
 -------------
 
-.. code:: Python
+.. code-block:: Python
 
     from bravado.client import SwaggerClient
     client = SwaggerClient.from_url('http://petstore.swagger.io/v2/swagger.json')
@@ -63,7 +63,7 @@ Example with Basic Authentication
     pet = client.pet.getPetById(petId=42).result()
 
 Example with Header Authentication
----------------------------------
+----------------------------------
 
 .. code-block:: python
 
@@ -81,6 +81,22 @@ Example with Header Authentication
     )
     pet = client.pet.getPetById(petId=42).result()
 
+Example with Fido Client (Async Http Client)
+--------------------------------------------
+
+.. code-block:: python
+
+    # Install bravado with fido extra (``pip install bravado[fido]``)
+    from bravado.fido_client import FidoClient
+    from bravado.client import SwaggerClient
+
+    http_client = FidoClient()
+    client = SwaggerClient.from_url(
+        'http://petstore.swagger.io/v2/swagger.json',
+        http_client=http_client,
+    )
+    pet = client.pet.getPetById(petId=42).result()
+
 Documentation
 -------------
 
@@ -89,10 +105,14 @@ More documentation is available at http://bravado.readthedocs.org
 Installation
 ------------
 
-::
+.. code-block:: bash
 
+    # To install bravado with Synchronous Http Client only.
     $ pip install bravado
 
+    # To install bravado with Synchronous and Asynchronous Http Client (RequestsClient and FidoClient).
+    $ pip install bravado[fido]
+
 Development
 ===========
 
@@ -104,10 +124,11 @@ recommended to keep dependencies and libraries isolated.
 Setup
 -----
 
-::
+.. code-block:: bash
 
     # Run tests
     tox
+
     # Install git pre-commit hooks
     tox -e pre-commit install
 

docs/source/quickstart.rst

@@ -61,14 +61,19 @@ Time to get Twisted! (Asynchronous client)
 
         client = SwaggerClient.from_url(
             'http://petstore.swagger.io/v2/swagger.json',
-            FidoClient())
+            FidoClient()
+        )
 
         result = client.pet.getPetById(petId=42).result(timeout=4)
 
 .. note::
 
         ``timeout`` parameter here is the timeout (in seconds) the call will block waiting for the complete response. The default timeout is to wait indefinitely.
 
+.. note::
+
+        To use Fido client you should install bravado with fido extra via ``pip install bravado[fido]``.
+
 This is too fancy for me! I want a simple dict response!
 --------------------------------------------------------
 
@@ -81,7 +86,8 @@ This is too fancy for me! I want a simple dict response!
 
         client = SwaggerClient.from_url(
             'http://petstore.swagger.io/v2/swagger.json',
-            config={'use_models': False})
+            config={'use_models': False}
+        )
 
         result = client.pet.getPetById(petId=42).result(timeout=4)