Metadata-Version: 2.1
Name: django-sql-explorer
Version: 4.0.2
Summary: A pluggable app that allows users (admins) to execute SQL, view, and export the results.
Home-page: https://github.com/chrisclark/django-sql-explorer
Author: Chris Clark
Author-email: chris@untrod.com
Maintainer: Mark Walker
Maintainer-email: theshow@gmail.com
License: MIT
Project-URL: Changes, https://django-sql-explorer.readthedocs.io/en/latest/history.html
Project-URL: Documentation, https://django-sql-explorer.readthedocs.io/en/latest/
Project-URL: Issues, https://github.com/chrisclark/django-sql-explorer/issues
Keywords: django sql explorer reports reporting csv database query
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Utilities
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: Django >=3.2
Requires-Dist: sqlparse >=0.4.0
Provides-Extra: charts
Requires-Dist: matplotlib <4 ; extra == 'charts'
Requires-Dist: seaborn <0.12 ; extra == 'charts'
Provides-Extra: snapshots
Requires-Dist: boto3 >=1.20.0 ; extra == 'snapshots'
Requires-Dist: celery >=4.0 ; extra == 'snapshots'
Provides-Extra: xls
Requires-Dist: xlsxwriter >=1.3.6 ; extra == 'xls'

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

.. image:: http://img.shields.io/pypi/v/django-sql-explorer.svg?style=flat-square
    :target: https://pypi.python.org/pypi/django-sql-explorer/
    :alt: Latest Version

.. image:: http://img.shields.io/pypi/dm/django-sql-explorer.svg?style=flat-square
    :target: https://pypi.python.org/pypi/django-sql-explorer/
    :alt: Downloads

.. image:: http://img.shields.io/pypi/l/django-sql-explorer.svg?style=flat-square
    :target: https://pypi.python.org/pypi/django-sql-explorer/
    :alt: License

SQL Explorer
============

`Documentation <https://django-sql-explorer.readthedocs.io/en/latest/>`_

SQL Explorer aims to make the flow of data between people fast,
simple, and confusion-free. It is a Django-based application that you
can add to an existing Django site, or use as a standalone business
intelligence tool. It will happily connect to any SQL database that
`Django supports <https://docs.djangoproject.com/en/5.0/ref/databases/>`_.

Quickly write and share SQL queries in a simple, usable SQL editor,
view the results in the browser, and keep the information flowing!

SQL Explorer values simplicity, intuitive use, unobtrusiveness,
stability, and the principle of least surprise. Sql Explorer is MIT
licensed, and pull requests are welcome.

Some key features include:

- Support for multiple connections
- Quick access to schema information to make querying easier
- In-browser pivot tables (which can also be shared via URLs)
- Ability to snapshot queries on a regular schedule, capturing changing
  data
- Query history and logs
- Quick in-browser statistics, pivot tables, and scatter-plots (saving
  a trip to Excel for simple analyses)
- Basic code-completion in the SQL editor
- Parameterized queries that automatically generate a friendly UI for
  users who don't know SQL
- A playground area for quickly running ad-hoc queries
- Send query results via email
- Saved queries can be exposed as a quick-n-dirty JSON API if desired
- ...and more!

Screenshots
-----------

**Writing a query and viewing the schema helper**

.. image:: https://sql-explorer.s3.amazonaws.com/4.0-query-with-schema.png

**Viewing all queries**

.. image:: https://sql-explorer.s3.amazonaws.com/4.0-query-list.png

**Query results rendered in browser**

.. image:: https://sql-explorer.s3.amazonaws.com/4.0-query-results.png

**Pivot in browser**

.. image:: https://sql-explorer.s3.amazonaws.com/4.0-pivot.png

Development
------------

Included is a test_project that you can use to kick the tires. Just
create a new virtualenv, cd into ``test_project`` and run ``start.sh`` (or
walk through the steps yourself) to get a test instance of the app up
and running.

You can now navigate to 127.0.0.1:8000/ and begin exploring!
