django-sql-explorer


Namedjango-sql-explorer JSON
Version 4.0.2 PyPI version JSON
download
home_pagehttps://github.com/chrisclark/django-sql-explorer
SummaryA pluggable app that allows users (admins) to execute SQL, view, and export the results.
upload_time2024-02-07 00:21:29
maintainerMark Walker
docs_urlNone
authorChris Clark
requires_python>=3.8
licenseMIT
keywords django sql explorer reports reporting csv database query
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. 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!

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/chrisclark/django-sql-explorer",
    "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/4a/42/a2dce80fe0102eb4a2fdc0b1c00d3b57dd1c019969545499d6804caa096e/django-sql-explorer-4.0.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`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\nSQL Explorer values simplicity, intuitive use, unobtrusiveness,\nstability, and the principle of least surprise. Sql Explorer is MIT\nlicensed, and pull requests are welcome.\n\nSome key features include:\n\n- Support for multiple connections\n- Quick access to schema information to make querying easier\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**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/ 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.0.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://github.com/chrisclark/django-sql-explorer",
        "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": "49b2b9e715720278caff24cda5095137dba4ea4630c4d22ab8b9755eff644099",
                "md5": "b1136f4904d0b1f2edff46f901380bfa",
                "sha256": "1c0fd62879f7f600523eda0b1ab3c15c199988dd2532b4b7ef15e0d8d04ac751"
            },
            "downloads": -1,
            "filename": "django_sql_explorer-4.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b1136f4904d0b1f2edff46f901380bfa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 678776,
            "upload_time": "2024-02-07T00:21:24",
            "upload_time_iso_8601": "2024-02-07T00:21:24.931219Z",
            "url": "https://files.pythonhosted.org/packages/49/b2/b9e715720278caff24cda5095137dba4ea4630c4d22ab8b9755eff644099/django_sql_explorer-4.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4a42a2dce80fe0102eb4a2fdc0b1c00d3b57dd1c019969545499d6804caa096e",
                "md5": "0e8269567456f7fb814e02f2e291018f",
                "sha256": "4b6c392adb97205ecf8e9f3505437c07da8aab1b84491387acb38ee63a5b36bb"
            },
            "downloads": -1,
            "filename": "django-sql-explorer-4.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "0e8269567456f7fb814e02f2e291018f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 649885,
            "upload_time": "2024-02-07T00:21:29",
            "upload_time_iso_8601": "2024-02-07T00:21:29.088260Z",
            "url": "https://files.pythonhosted.org/packages/4a/42/a2dce80fe0102eb4a2fdc0b1c00d3b57dd1c019969545499d6804caa096e/django-sql-explorer-4.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-07 00:21:29",
    "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"
}
        
Elapsed time: 0.27697s