Metadata-Version: 2.4
Name: django-sql-explorer
Version: 5.3
Summary: SQL Reporting that Just Works. Fast, simple, and confusion-free.Write and share queries in a delightful SQL editor, with AI assistance
Home-page: https://www.sqlexplorer.io
Author: Chris Clark
Author-email: chris@sqlexplorer.io
Maintainer: Chris Clark
Maintainer-email: chris@sqlexplorer.io
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/explorerhq/sql-explorer/issues
Keywords: django sql explorer reports reporting csv json 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
Requires-Dist: requests>=2.2
Requires-Dist: django-cryptography-django5==2.2
Requires-Dist: cryptography>=42.0
Provides-Extra: charts
Requires-Dist: matplotlib>=3.9; extra == "charts"
Provides-Extra: snapshots
Requires-Dist: boto3>=1.30.0; extra == "snapshots"
Requires-Dist: celery>=4.0; extra == "snapshots"
Provides-Extra: xls
Requires-Dist: xlsxwriter>=1.3.6; extra == "xls"
Provides-Extra: assistant
Requires-Dist: openai>=1.6.1; extra == "assistant"
Provides-Extra: uploads
Requires-Dist: python-dateutil>=2.9; extra == "uploads"
Requires-Dist: pandas>=2.2; extra == "uploads"
Requires-Dist: boto3>=1.30.0; extra == "uploads"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

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

* `Official Website <https://www.sqlexplorer.io/>`_
* `Live Demo <https://demo.sqlexplorer.io/>`_
* `Documentation <https://django-sql-explorer.readthedocs.io/en/latest/>`_

Video Tour
----------

.. |inline-image| image:: https://sql-explorer.s3.amazonaws.com/video-thumbnail.png
   :target: https://sql-explorer.s3.amazonaws.com/Sql+Explorer+5.mp4
   :height: 10em

|inline-image|

Quick Start
-----------

Included is a complete test project that you can use to kick the tires.

1. Run ``docker compose up``
2. Navigate to 127.0.0.1:8000/explorer/
3. log in with admin/admin
4. Begin exploring!

This will also run a Vite dev server with hot reloading for front-end changes.

About
-----

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/>`_
as well as user-uploaded CSV, JSON, or SQLite databases.

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

Add an OpenAI (or other provider) API key and get an LLM-powered
SQL assistant that can help write and debug queries. The assistant
will automatically add relevant context and schema into the underlying
LLM prompt.

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

Some key features include:

- Support for multiple connections, admin configured or user-provided.
- Users can upload and immediately query JSON or CSV files.
- AI-powered SQL assistant
- Quick access to schema information to make querying easier
  (including autocomplete)
- 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)
- 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/5.0-query-with-schema.png

------------------

**Using the SQL AI Assistant**

.. image:: https://sql-explorer.s3.amazonaws.com/5.0-assistant.png

------------------

**Viewing all queries**

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

------------------

**Query results w/ stats summary**

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

------------------

**Pivot in browser**

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

------------------

**View logs**

.. image:: https://sql-explorer.s3.amazonaws.com/5.0-querylogs.png

