.. 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/>`_
`Full 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!
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**
.. image:: https://sql-explorer.s3.amazonaws.com/4.0-query-with-schema.png
**Using the SQL Assistant**
.. image:: https://sql-explorer.s3.amazonaws.com/4.1-sql-assistant.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/explorer/ and begin exploring!
Raw data
{
"_id": null,
"home_page": "https://www.sqlexplorer.io",
"name": "django-sql-explorer",
"maintainer": "Mark Walker",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "theshow@gmail.com",
"keywords": "django sql explorer reports reporting csv database query",
"author": "Chris Clark",
"author_email": "chris@untrod.com",
"download_url": "https://files.pythonhosted.org/packages/e7/38/6cb7be13ce4ee6109d85993c7f76f41756a0d04643a4a05ea631ce8d5d2b/django_sql_explorer-4.2.tar.gz",
"platform": null,
"description": ".. image:: https://readthedocs.org/projects/django-sql-explorer/badge/?version=latest\n :target: https://django-sql-explorer.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: http://img.shields.io/pypi/v/django-sql-explorer.svg?style=flat-square\n :target: https://pypi.python.org/pypi/django-sql-explorer/\n :alt: Latest Version\n\n.. image:: http://img.shields.io/pypi/dm/django-sql-explorer.svg?style=flat-square\n :target: https://pypi.python.org/pypi/django-sql-explorer/\n :alt: Downloads\n\n.. image:: http://img.shields.io/pypi/l/django-sql-explorer.svg?style=flat-square\n :target: https://pypi.python.org/pypi/django-sql-explorer/\n :alt: License\n\nSQL Explorer\n============\n\n`Official Website <https://www.sqlexplorer.io/>`_\n\n`Full Documentation <https://django-sql-explorer.readthedocs.io/en/latest/>`_\n\nSQL Explorer aims to make the flow of data between people fast,\nsimple, and confusion-free. It is a Django-based application that you\ncan add to an existing Django site, or use as a standalone business\nintelligence tool. It will happily connect to any SQL database that\n`Django supports <https://docs.djangoproject.com/en/5.0/ref/databases/>`_.\n\nQuickly write and share SQL queries in a simple, usable SQL editor,\nview the results in the browser, and keep the information flowing!\n\nAdd an OpenAI (or other provider) API key and get an LLM-powered\nSQL assistant that can help write and debug queries. The assistant\nwill automatically add relevant context and schema into the underlying\nLLM prompt.\n\nSQL Explorer values simplicity, intuitive use, unobtrusiveness,\nstability, and the principle of least surprise. The project is MIT\nlicensed, and pull requests are welcome.\n\nSome key features include:\n\n- Support for multiple connections\n- AI-powered SQL assistant\n- Quick access to schema information to make querying easier\n (including autocomplete)\n- In-browser pivot tables (which can also be shared via URLs)\n- Ability to snapshot queries on a regular schedule, capturing changing\n data\n- Query history and logs\n- Quick in-browser statistics, pivot tables, and scatter-plots (saving\n a trip to Excel for simple analyses)\n- Basic code-completion in the SQL editor\n- Parameterized queries that automatically generate a friendly UI for\n users who don't know SQL\n- A playground area for quickly running ad-hoc queries\n- Send query results via email\n- Saved queries can be exposed as a quick-n-dirty JSON API if desired\n- ...and more!\n\nScreenshots\n-----------\n\n**Writing a query and viewing the schema helper**\n\n.. image:: https://sql-explorer.s3.amazonaws.com/4.0-query-with-schema.png\n\n**Using the SQL Assistant**\n\n.. image:: https://sql-explorer.s3.amazonaws.com/4.1-sql-assistant.png\n\n**Viewing all queries**\n\n.. image:: https://sql-explorer.s3.amazonaws.com/4.0-query-list.png\n\n**Query results rendered in browser**\n\n.. image:: https://sql-explorer.s3.amazonaws.com/4.0-query-results.png\n\n**Pivot in browser**\n\n.. image:: https://sql-explorer.s3.amazonaws.com/4.0-pivot.png\n\nDevelopment\n------------\n\nIncluded is a test_project that you can use to kick the tires. Just\ncreate a new virtualenv, cd into ``test_project`` and run ``start.sh`` (or\nwalk through the steps yourself) to get a test instance of the app up\nand running.\n\nYou can now navigate to 127.0.0.1:8000/explorer/ and begin exploring!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A pluggable app that allows users (admins) to execute SQL, view, and export the results.",
"version": "4.2",
"project_urls": {
"Changes": "https://django-sql-explorer.readthedocs.io/en/latest/history.html",
"Documentation": "https://django-sql-explorer.readthedocs.io/en/latest/",
"Homepage": "https://www.sqlexplorer.io",
"Issues": "https://github.com/chrisclark/django-sql-explorer/issues"
},
"split_keywords": [
"django",
"sql",
"explorer",
"reports",
"reporting",
"csv",
"database",
"query"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a254b73c119af0a0269a1126b9cae9bc781009ac99b3d33e219f0ffb5540a9d",
"md5": "054c55fc92528eab720d6cb9ae34d5fb",
"sha256": "3b6dba5447d53dae5f33aef9d0e02239523b6d5756d9bb07658cc9172c09474c"
},
"downloads": -1,
"filename": "django_sql_explorer-4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "054c55fc92528eab720d6cb9ae34d5fb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 713119,
"upload_time": "2024-04-26T14:15:45",
"upload_time_iso_8601": "2024-04-26T14:15:45.095462Z",
"url": "https://files.pythonhosted.org/packages/5a/25/4b73c119af0a0269a1126b9cae9bc781009ac99b3d33e219f0ffb5540a9d/django_sql_explorer-4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7386cb7be13ce4ee6109d85993c7f76f41756a0d04643a4a05ea631ce8d5d2b",
"md5": "3c775eff43849fcb2181216958109962",
"sha256": "9bfff9b471c9553f337b8a8e0b8c099110f6611d342c24d50d56229702c5c62b"
},
"downloads": -1,
"filename": "django_sql_explorer-4.2.tar.gz",
"has_sig": false,
"md5_digest": "3c775eff43849fcb2181216958109962",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 679697,
"upload_time": "2024-04-26T14:15:46",
"upload_time_iso_8601": "2024-04-26T14:15:46.810637Z",
"url": "https://files.pythonhosted.org/packages/e7/38/6cb7be13ce4ee6109d85993c7f76f41756a0d04643a4a05ea631ce8d5d2b/django_sql_explorer-4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 14:15:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chrisclark",
"github_project": "django-sql-explorer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-sql-explorer"
}
JSON
