# django-sql-dashboard
[](https://pypi.org/project/django-sql-dashboard/)
[](https://github.com/simonw/django-sql-dashboard/releases)
[](https://github.com/simonw/django-sql-dashboard/actions?query=workflow%3ATest)
[](http://django-sql-dashboard.datasette.io/en/latest/?badge=latest)
[](https://github.com/simonw/django-sql-dashboard/blob/main/LICENSE)
Django SQL Dashboard provides an authenticated interface for executing read-only SQL queries directly against your PostgreSQL database, bringing a useful subset of [Datasette](https://datasette.io/) to Django.
Applications include ad-hoc analysis and debugging, plus the creation of reporting dashboards that can be shared with team members or published online.
See my blog for [more about this project](https://simonwillison.net/2021/May/10/django-sql-dashboard/), including [a video demo](https://www.youtube.com/watch?v=ausrmMZkPEY).
Features include:
- Safely run read-only one or more SQL queries against your database and view the results in your browser
- Bookmark queries and share those links with other members of your team
- Create [saved dashboards](https://django-sql-dashboard.datasette.io/en/latest/saved-dashboards.html) from your queries, with full control over who can view and edit them
- [Named parameters](https://django-sql-dashboard.datasette.io/en/latest/sql.html#sql-parameters) such as `select * from entries where id = %(id)s` will be turned into form fields, allowing quick creation of interactive dashboards
- Produce [bar charts](https://django-sql-dashboard.datasette.io/en/latest/widgets.html#bar-label-bar-quantity), [progress bars](https://django-sql-dashboard.datasette.io/en/latest/widgets.html#total-count-completed-count) and more from SQL queries, with the ability to easily create new [custom dashboard widgets](https://django-sql-dashboard.datasette.io/en/latest/widgets.html#custom-widgets) using the Django template system
- Write SQL queries that safely construct and render [markdown](https://django-sql-dashboard.datasette.io/en/latest/widgets.html#markdown) and [HTML](https://django-sql-dashboard.datasette.io/en/latest/widgets.html#html)
- Export the full results of a SQL query as a downloadable CSV or TSV file, using a combination of Django's [streaming HTTP response](https://docs.djangoproject.com/en/3.2/ref/request-response/#django.http.StreamingHttpResponse) mechanism and PostgreSQL [server-side cursors](https://www.psycopg.org/docs/usage.html#server-side-cursors) to efficiently stream large amounts of data without running out of resources
- Copy and paste the results of SQL queries directly into tools such as Google Sheets or Excel
- Uses Django's authentication system, so dashboard accounts can be granted using Django's Admin tools
## Documentation
Full documentation is at [django-sql-dashboard.datasette.io](https://django-sql-dashboard.datasette.io/)
## Screenshot
<img width="1018" alt="Screenshot showing a SQL query that produces a table and one that produces a bar chart" src="https://user-images.githubusercontent.com/9599/124050883-42ad2300-d9d0-11eb-83e6-44ad85f7ef64.png">
## Alternatives
- [django-sql-explorer](https://github.com/groveco/django-sql-explorer) provides a related set of functionality that also works against database backends other than PostgreSQL
Raw data
{
"_id": null,
"home_page": "https://github.com/simonw/django-sql-dashboard",
"name": "django-sql-dashboard",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Simon Willison",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/75/b7/ac4015ea4aa2962d20408077c03c1a4d79298e967272a7dfe5bf1d52c2ec/django-sql-dashboard-1.2.tar.gz",
"platform": null,
"description": "# django-sql-dashboard\n\n[](https://pypi.org/project/django-sql-dashboard/)\n[](https://github.com/simonw/django-sql-dashboard/releases)\n[](https://github.com/simonw/django-sql-dashboard/actions?query=workflow%3ATest)\n[](http://django-sql-dashboard.datasette.io/en/latest/?badge=latest)\n[](https://github.com/simonw/django-sql-dashboard/blob/main/LICENSE)\n\nDjango SQL Dashboard provides an authenticated interface for executing read-only SQL queries directly against your PostgreSQL database, bringing a useful subset of [Datasette](https://datasette.io/) to Django.\n\nApplications include ad-hoc analysis and debugging, plus the creation of reporting dashboards that can be shared with team members or published online.\n\nSee my blog for [more about this project](https://simonwillison.net/2021/May/10/django-sql-dashboard/), including [a video demo](https://www.youtube.com/watch?v=ausrmMZkPEY).\n\nFeatures include:\n\n- Safely run read-only one or more SQL queries against your database and view the results in your browser\n- Bookmark queries and share those links with other members of your team\n- Create [saved dashboards](https://django-sql-dashboard.datasette.io/en/latest/saved-dashboards.html) from your queries, with full control over who can view and edit them\n- [Named parameters](https://django-sql-dashboard.datasette.io/en/latest/sql.html#sql-parameters) such as `select * from entries where id = %(id)s` will be turned into form fields, allowing quick creation of interactive dashboards\n- Produce [bar charts](https://django-sql-dashboard.datasette.io/en/latest/widgets.html#bar-label-bar-quantity), [progress bars](https://django-sql-dashboard.datasette.io/en/latest/widgets.html#total-count-completed-count) and more from SQL queries, with the ability to easily create new [custom dashboard widgets](https://django-sql-dashboard.datasette.io/en/latest/widgets.html#custom-widgets) using the Django template system\n- Write SQL queries that safely construct and render [markdown](https://django-sql-dashboard.datasette.io/en/latest/widgets.html#markdown) and [HTML](https://django-sql-dashboard.datasette.io/en/latest/widgets.html#html)\n- Export the full results of a SQL query as a downloadable CSV or TSV file, using a combination of Django's [streaming HTTP response](https://docs.djangoproject.com/en/3.2/ref/request-response/#django.http.StreamingHttpResponse) mechanism and PostgreSQL [server-side cursors](https://www.psycopg.org/docs/usage.html#server-side-cursors) to efficiently stream large amounts of data without running out of resources\n- Copy and paste the results of SQL queries directly into tools such as Google Sheets or Excel\n- Uses Django's authentication system, so dashboard accounts can be granted using Django's Admin tools\n\n## Documentation\n\nFull documentation is at [django-sql-dashboard.datasette.io](https://django-sql-dashboard.datasette.io/)\n\n## Screenshot\n\n<img width=\"1018\" alt=\"Screenshot showing a SQL query that produces a table and one that produces a bar chart\" src=\"https://user-images.githubusercontent.com/9599/124050883-42ad2300-d9d0-11eb-83e6-44ad85f7ef64.png\">\n\n## Alternatives\n\n- [django-sql-explorer](https://github.com/groveco/django-sql-explorer) provides a related set of functionality that also works against database backends other than PostgreSQL\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Django app for building dashboards using raw SQL queries",
"version": "1.2",
"project_urls": {
"CI": "https://github.com/simonw/django-sql-dashboard/actions",
"Changelog": "https://github.com/simonw/django-sql-dashboard/releases",
"Documentation": "https://django-sql-dashboard.datasette.io/",
"Homepage": "https://github.com/simonw/django-sql-dashboard",
"Issues": "https://github.com/simonw/django-sql-dashboard/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "315c5c16c89d24b661c9ac7746b11b377acbf443f96cfa71f9c1e1283260c3bb",
"md5": "9a216958ba43545287695d0970576f68",
"sha256": "656e9d8ecd2d0ce6a877a732f66adb69d79c4b535c5fcbc0dc5099ef97de260a"
},
"downloads": -1,
"filename": "django_sql_dashboard-1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a216958ba43545287695d0970576f68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 35254,
"upload_time": "2023-12-16T07:05:50",
"upload_time_iso_8601": "2023-12-16T07:05:50.179464Z",
"url": "https://files.pythonhosted.org/packages/31/5c/5c16c89d24b661c9ac7746b11b377acbf443f96cfa71f9c1e1283260c3bb/django_sql_dashboard-1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "75b7ac4015ea4aa2962d20408077c03c1a4d79298e967272a7dfe5bf1d52c2ec",
"md5": "d9dd09f1407f70f553cf615796feb879",
"sha256": "7bc8ee6cb212d74147216e31ec392e29f5c16bdcb5cc8e76a3715f0d527713a9"
},
"downloads": -1,
"filename": "django-sql-dashboard-1.2.tar.gz",
"has_sig": false,
"md5_digest": "d9dd09f1407f70f553cf615796feb879",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 27193,
"upload_time": "2023-12-16T07:05:51",
"upload_time_iso_8601": "2023-12-16T07:05:51.924051Z",
"url": "https://files.pythonhosted.org/packages/75/b7/ac4015ea4aa2962d20408077c03c1a4d79298e967272a7dfe5bf1d52c2ec/django-sql-dashboard-1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-16 07:05:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "simonw",
"github_project": "django-sql-dashboard",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "django-sql-dashboard"
}
JSON
