Metadata-Version: 2.1
Name: sqlalchemy-pretty-sql
Version: 0.4.0
Summary: given a sqlalchemy query, display a well formatted and highlighted sql code.
Home-page: https://github.com/mgaitan/sqlalchemy-pretty-sql
Author: Martín Gaitán
Author-email: gaitan@gmail.com
License: BSD
Keywords: sqlalchemy-pretty-sql,sqlalchemy,sql,jupyter notebook
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.4
Classifier: Framework :: Jupyter
Classifier: Framework :: IPython
Classifier: Programming Language :: SQL
Requires-Dist: sqlparse (>=0.3.0)
Requires-Dist: Pygments (>=2.4.0)
Requires-Dist: IPython (>=6.0)

===============================
sqlalchemy-pretty-sql
===============================

Given a sqlalchemy query, display a well formatted and highlighted sql code.

Install and usage
=================

.. code-block:: bash

    pip install sqlalchemy-pretty-sql

And then just import the package in your notebook session

.. code-block:: python


    In[3]: import sqlalchemy_pretty_sql
    In[4]: query

After ``sqlalchemy_pretty_sql`` is imported, its ``pretty_sql`` function
is registered to display the sql of any ``sqlalchemy.orm.query.Query`` object.


See the `example <https://github.com/mgaitan/sqlalchemy-pretty-sql/blob/master/example.ipynb>`_.

