django-debug-toolbar-alchemy 0.1.5
Django Debug Toolbar panel for SQLAlchemy.
License: MIT
Keywords: django django-debug-toolbar sqlalchemy

============================
Django Debug Toolbar Alchemy
============================

.. image:: https://badge.fury.io/py/django-debug-toolbar-alchemy.svg
    :target: http://badge.fury.io/py/django-debug-toolbar-alchemy

Django Debug Toolbar panel for SQLAlchemy.

* Free software: MIT license
* GitHub: https://github.com/miki725/django-debug-toolbar-alchemy

Overview
--------

This package completely mimics default Django Debug Toolbar SQL panel
(internally its actually subclassed) but instead of displaying queries done
via Django ORM, SQLAlchemy generated queries are displayed.
Rest of the functionality is the same.

Installing
----------

First install::

    $ pip install django-debug-toolbar-alchemy

Then in your settings::

    # settings.py
    DEBUG_TOOLBAR_PANELS = [
        # other panels
        'debug_toolbar_alchemy.panels.sql.SQLPanel',
        # other panels
    ]

In order to support multiple DB databases, alias getter callable
must be specified in settings::

    # settings.py
    DEBUG_TOOLBAR_CONFIG = {
        'ALCHEMY_DB_ALIASES': '<dot patht to alias getter>',
    }

Alias getter must return a dictionary of aliases as keys and
SQLAlchemy engines as values.
If your application uses global session,
you can get the engine from session instances::

    from myapp.db import session, session_slave

    def alchemy_dbs():
        return {
            'default': session.bind,
            'slave': session_slave.bind,
        }




History
-------

0.1.5 (2018-09-04)
~~~~~~~~~~~~~~~~~~

* Fixed when ``multiparams`` are name synonyms in ``UPDATE`` statements.
* Added support for ``similar`` queries added in debug toolbar base ``SQLPanel``.

0.1.4 (2018-09-04)
~~~~~~~~~~~~~~~~~~

* Added template to be included in ``dist`` package.

0.1.3 (2018-09-03)
~~~~~~~~~~~~~~~~~~

* Added a way to run ``SELECT`` and ``EXPLAIN`` to queries in debug toolbar.
  Tested in ``sqlite``, ``postgresql`` and ``oracle``.

0.1.2 (2018-08-30)
~~~~~~~~~~~~~~~~~~

* Fix bug by attaching SQLAlchemy events at most once.
  Otherwise in some cases when multiple threads are used,
  event handlers ``deque`` would be mutated while
  other SQLAlchemy events are running since
  event handling is not thread-safe in SQA.

0.1.1 (2018-07-13)
~~~~~~~~~~~~~~~~~~

* Fix bug which did not correctly track plain string clauses.

0.1.0 (2017-10-04)
~~~~~~~~~~~~~~~~~~

* First release on PyPI.


Credits
-------

Development Lead
----------------

* Miroslav Shubernetskiy - https://github.com/miki725

Contributors
------------

* None yet. Why not be the first?


License
-------

::

    The MIT License (MIT)

    Copyright (c) 2017, Miroslav Shubernetskiy

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.