sprockets.clients.postgresql/docs/index.rst
2014-08-29 11:07:04 -04:00

68 lines
No EOL
2.3 KiB
ReStructuredText

sprockets.clients.postgresql
============================
The ``sprockets.clients.postgresql`` package wraps the
`Queries <http://queries.readthedocs.org>`_ package providing environment
variable based configuration for connecting to PostgreSQL.
|Version| |Downloads| |Status| |Coverage| |License|
Installation
------------
``sprockets.clients.postgresql`` is available on the
`Python Package Index <https://pypi.python.org/pypi/sprockets.clients.postgresql>`_
and can be installed via ``pip`` or ``easy_install``:
.. code:: bash
pip install sprockets.clients.postgresql
Requirements
------------
- `queries <https://github.com/gmr/queries>`_
- `sprockets <https://github.com/sprockets/sprockets>`_
API Documentation
-----------------
.. toctree::
:maxdepth: 2
api
examples
Version History
---------------
See :doc:`history`
Issues
------
Please report any issues to the Github project at `https://github.com/sprockets/sprockets.clients.postgresql/issues <https://github.com/sprockets/sprockets.clients.postgresql/issues>`_
Source
------
sprockets.clients.postgresql source is available on Github at `https://github.com/sprockets/sprockets.clients.postgresql <https://github.com/sprockets/sprockets.clients.postgresql>`_
License
-------
sprockets.clients.postgresql is released under the `3-Clause BSD license <https://github.com/sprockets/sprockets.clients.postgresql/blob/master/LICENSE>`_.
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. |Version| image:: https://badge.fury.io/py/sprockets.clients.postgresql.svg?
:target: http://badge.fury.io/py/sprockets.clients.postgresql
.. |Status| image:: https://travis-ci.org/sprockets/sprockets.clients.postgresql.svg?branch=master
:target: https://travis-ci.org/sprockets/sprockets.clients.postgresql
.. |Coverage| image:: https://img.shields.io/coveralls/sprockets/sprockets.clients.postgresql.svg?
:target: https://coveralls.io/r/sprockets/sprockets.clients.postgresql
.. |Downloads| image:: https://pypip.in/d/sprockets.clients.postgresql/badge.svg?
:target: https://pypi.python.org/pypi/sprockets.clients.postgresql
.. |License| image:: https://pypip.in/license/sprockets.clients.postgresql/badge.svg?
:target: https://sprocketsclientspostgresql.readthedocs.org