Skip to content

Commit

Permalink
Adjust docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bcb committed Oct 11, 2016
1 parent f3a8e53 commit 65c54ff
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,24 @@ jsonrpcclient Guide
.. contents::
:local:

Choose a client
===============
Installation
============

To use the *requests* library to send messages, install it:
Install jsonrpcclient with the *requests* library:

.. sourcecode:: sh

$ pip install 'jsonrpcclient[requests]'

Import the ``HTTPServer`` class and instantiate it, passing the server
Import the ``HTTPClient`` class and instantiate it, passing the server
endpoint::

>>> from jsonrpcclient.http_server import HTTPServer
>>> client = HTTPServer('http://cats.com')
>>> from jsonrpcclient.http_client import HTTPClient
>>> client = HTTPClient('http://cats.com')

There are other :doc:`options <examples>` available which use different
protocols to send a message. To use those you would import a different class.
But regardless of the client used, the rest of the usage described below is the
same.
There are other :doc:`clients <examples>` available which use different
protocols to send a message. Regardless of the client, the rest of the usage
described below is the same.

Sending a request
=================
Expand Down

0 comments on commit 65c54ff

Please sign in to comment.