github/sprockets.clients.postgresql
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets.clients.postgresql.git synced 2024-12-28 03:00:21 +00:00
Code Issues Projects Releases Packages Wiki Activity
PostgreSQL client library wrapper providing environment variable based configuration
10 commits 2 branches 3 tags 50 KiB
Python 100%
Find a file
Gavin M. Roy 86043e2733 Bump the version
2014-09-05 16:32:44 -04:00
docs Bump the version 2014-09-05 16:32:44 -04:00
sprockets Add ease of use imports and add integration tests 2014-09-05 16:16:09 -04:00
.gitignore Initial commit 2014-08-28 18:44:35 -04:00
.travis.yml Add ease of use imports and add integration tests 2014-09-05 16:16:09 -04:00
dev-requirements.txt Add ease of use imports and add integration tests 2014-09-05 16:16:09 -04:00
LICENSE Initial commit 2014-08-29 11:07:04 -04:00
MANIFEST.in Add ease of use imports and add integration tests 2014-09-05 16:16:09 -04:00
README.rst Remove the deprecated dependency 2014-09-05 16:25:04 -04:00
requirements.txt Add ease of use imports and add integration tests 2014-09-05 16:16:09 -04:00
setup.cfg Add ease of use imports and add integration tests 2014-09-05 16:16:09 -04:00
setup.py Bump the version 2014-09-05 16:32:44 -04:00
test-requirements.txt Add ease of use imports and add integration tests 2014-09-05 16:16:09 -04:00
tests.py Add ease of use imports and add integration tests 2014-09-05 16:16:09 -04:00

README.rst 

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

Documentation
-------------
https://sprocketsclientspostgresql.readthedocs.org

Requirements
------------
-  `queries`_

Example
-------
The following example sets the environment variables for connecting to
PostgreSQL on localhost to the ``postgres`` database and issues a query.

.. code:: python

    import os

    from sprockets.clients import postgresql

    os.environ['POSTGRES_HOST'] = 'localhost'
    os.environ['POSTGRES_USER'] = 'postgres'
    os.environ['POSTGRES_PORT'] = 5432
    os.environ['POSTGRES_DBNAME'] = 'postgres'

    session = postgresql.Session('postgres')
    result = session.query('SELECT 1')
    print(repr(result))

Version History
---------------
Available at https://sprocketsclientspostgresql.readthedocs.org/en/latest/history.html

.. |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