Skip to content

Commit

Permalink
Merge pull request histrio#33 from pyfisch/master
Browse files Browse the repository at this point in the history
Improved index.rst
  • Loading branch information
Andrey Antukh committed Mar 20, 2014
2 parents e9b53da + 99df686 commit 4fcf4d1
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,30 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==========
py-couchdb
==========

Release v\ |version|.

py-couchdb is an :ref:`BSD Licensed`, modern pure python CouchDB client.
py-couchdb is a :ref:`BSD Licensed`, modern pure `Python`_ `CouchDB`_ client.

Currently there are several libraries in python to connect to couchdb. **Why one more?** It's very simple.
All seems not be maintained, all libraries used standard Python libraries for http requests, and are not compatible with python3.
Currently there are several libraries for Python to connect to CouchDB. **Why one more?** It's very simple.
All seem to be not maintained, all libraries use standard Python libraries for http requests, and are not compatible with Python3.

Advantages of py-couchdb
^^^^^^^^^^^^^^^^^^^^^^^^
========================

- Use `requests`_ for http requests (much faster than the standard library)
- Python2 and Python3 compatible with same codebase (with one exception, python view server that uses 2to3)
- Uses `requests`_ for http requests (much faster than the standard library)
- Python2 and Python3 compatible with same codebase (with one exception, Python view server that uses 2to3)
- Also compatible with pypy.

.. _python: http://python.org
.. _couchdb: http://couchdb.apache.org/
.. _requests: http://docs.python-requests.org/en/latest/

.. note::
requests 1.2 seems buggy with python3 and I strongly recommend use request 1.1 if you use python3
requests 1.2 seems buggy with Python3 and I strongly recommend use request 1.1 if you use Python3


Example:
Expand All @@ -35,12 +38,10 @@ Example:
>>> server.info()['version']
'1.2.1'
User guide
----------
==========

This part of the documentation makes a simple introduction of py-couchdb usage.
This part of the documentation gives a simple introduction on py-couchdb usage.

.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit 4fcf4d1

Please sign in to comment.