A pluggable app that allows users (admins) to execute SQL, view, and export the results.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for clarkcw1 from gravatar.com clarkcw1 Avatar for markwalker from gravatar.com markwalker

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Chris Clark
  • Maintainer: Mark Walker
  • Tags django, sql, explorer, reports, reporting, csv, database, query
  • Requires: Python >=3.8
  • Provides-Extra: assistant, charts, snapshots, uploads, xls
Classifiers

Project description

Documentation Status Latest Version Downloads License

SQL Explorer

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.

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

  • AI-powered SQL assistant

  • Quick access to schema information to make querying easier (including autocomplete)

  • 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

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

Using the SQL Assistant

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

Viewing all queries

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

Query results rendered in browser

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

Pivot in browser

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/explorer/ and begin exploring!

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for clarkcw1 from gravatar.com clarkcw1 Avatar for markwalker from gravatar.com markwalker

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Chris Clark
  • Maintainer: Mark Walker
  • Tags django, sql, explorer, reports, reporting, csv, database, query
  • Requires: Python >=3.8
  • Provides-Extra: assistant, charts, snapshots, uploads, xls
Classifiers

Release history Release notifications | RSS feed

5.3

5.3b2 pre-release

5.3b1 pre-release

5.2

5.2b1 pre-release

5.1.1

5.1

5.1b1 pre-release

5.0.2

5.0.1

5.0

5.0b3 pre-release

This version

5.0b2 pre-release

5.0b1 pre-release

4.4b3 pre-release yanked

Reason this release was yanked:

Rereleased as 5.0 beta

4.4b1 pre-release yanked

Reason this release was yanked:

Re-released as 5.0 beta

4.3

4.2

4.2b1 pre-release

4.1

4.1b6 pre-release

4.1b5 pre-release

4.1b4 pre-release

4.1b2 pre-release

4.1b1 pre-release

4.0.2

4.0.1

4.0 yanked

Reason this release was yanked:

Supposed to be a beta

4.0b4 pre-release

4.0b3 pre-release

4.0b2 pre-release

3.2.1

3.2

3.1.1

3.1

3.0.1

3.0

2.5

2.5b0 pre-release

2.4.2

2.4.1

2.4

2.3

2.2

2.1.3

2.1.2

2.1.1

2.1

2.0

1.1.3

1.1.2

1.1.1

1.1

1.0

0.9.2

0.9.1

0.9

0.8

0.7

0.6

0.5.1

0.5

0.4.1

0.4

0.3

0.2

0.1.1

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_sql_explorer-5.0b2.tar.gz (857.0 kB view details)

Uploaded Source

Built Distribution

django_sql_explorer-5.0b2-py3-none-any.whl (894.3 kB view details)

Uploaded Python 3

File details

Details for the file django_sql_explorer-5.0b2.tar.gz.

File metadata

  • Download URL: django_sql_explorer-5.0b2.tar.gz
  • Upload date:
  • Size: 857.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for django_sql_explorer-5.0b2.tar.gz
Algorithm Hash digest
SHA256 9d3895262a2224e323688496c374a75d425f73a4cd25a9559b2a56805774b6fb
MD5 ef3f528d76b8fecb9726d25111581b14
BLAKE2b-256 93a5ad0fe2474d815c3f1d924e68a910b75306c2ba17c9ad17cdc5c31e108166

See more details on using hashes here.

Provenance

File details

Details for the file django_sql_explorer-5.0b2-py3-none-any.whl.

File metadata

File hashes

Hashes for django_sql_explorer-5.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 42d5993e37577668e329806acbd4c7edf648b688c1fcf5e9d816292e20520edd
MD5 1098d39acf548a02c69a49f3fda76fe8
BLAKE2b-256 fe0504b06b96d820a2d92050dfcadbd7aa2425074605ba9304ce1416e4fea5ca

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page