Metadata-Version: 2.0
Name: connexion-sql-utils
Version: 0.1.4
Summary: Sqlalchemy, Postgres, Connexion utility
Home-page: https://github.com/m-housh/connexion_sql_utils
Author: Michael Housh
Author-email: mhoush@houshhomeenergy.com
License: MIT license
Keywords: connexion_sql_utils
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: connexion (==1.1.5)
Requires-Dist: psycopg2 (>=2.7)
Requires-Dist: sqlalchemy (>=1.1.6)

===============================
Connexion Sqlalchemy Utils
===============================

.. image:: https://img.shields.io/pypi/v/connexion_sql_utils.svg
    :target: https://pypi.python.org/pypi/connexion_sql_utils

.. image:: https://img.shields.io/travis/m-housh/connexion_sql_utils.svg
    :target: https://travis-ci.org/m-housh/connexion_sql_utils

.. image:: https://coveralls.io/repos/github/m-housh/connexion_sql_utils/badge.svg?branch=master
    :target: https://coveralls.io/github/m-housh/connexion_sql_utils?branch=master

.. image:: https://readthedocs.org/projects/connexion_sql_utils/badge/?version=latest
    :target: https://connexion-sql-utils.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status


Sqlalchemy, Postgres, Connexion utility


* Documentation: https://connexion-sql-utils.readthedocs.io.


Features
--------

* Helps create REST api's quickly with ``Connexion``, ``Sqlalchemy``,
  and ``Postgresql``


Running example api in Docker
------------------------------

By cloning the repo:

.. code-block:: bash

    git clone https://github.com/m-housh/connexion_sql_utils.git

    cd ./connexion_sql_utils

    docker-compose up

Without cloning the repo:

.. code-block:: bash

    docker pull mhoush/connexion_sql_utils
    docker pull postgres/alpine

    docker run -d --name some_postgres \
        -e POSTGRES_PASSWORD=postgres \
        postgres:alpine

    docker run --rm -it --link some_postgres:postgres \
        -e DB_HOST=postgres \
        -e DB_PASSWORD=postgres \
        -p "8080:8080" \
        mhoush/connexion_sql_utils

Check out the example api at ``http://localhost:8080/ui``


Credits
---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage



=======
History
=======

0.1.0 (2017-03-08)
------------------

* First release on PyPI.


0.1.3
-----

* Added ability to pass a session into BaseMixin database methods.
* Added ``dump_method`` decorator to allow custom methods to be called while
  creating the json representation.

0.1.4
-----

* Added the ability to dump as dict instead of always being a json string.


