├── tests ├── test_project │ ├── __init__.py │ ├── urls.py │ └── settings.py └── test_django_plugin_datasette.py ├── .gitignore ├── .github └── workflows │ ├── test.yml │ └── publish.yml ├── pyproject.toml ├── README.md ├── django_plugin_datasette └── __init__.py └── LICENSE /tests/test_project/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .venv 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | venv 6 | .eggs 7 | .pytest_cache 8 | *.egg-info 9 | .DS_Store 10 | .vscode 11 | dist 12 | build 13 | -------------------------------------------------------------------------------- /tests/test_project/urls.py: -------------------------------------------------------------------------------- 1 | from django.http import HttpResponse 2 | from django.urls import path 3 | import djp 4 | 5 | urlpatterns = [ 6 | path("", lambda request: HttpResponse("Hello world")) 7 | ] + djp.urlpatterns() 8 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: [push, pull_request] 4 | 5 | permissions: 6 | contents: read 7 | 8 | jobs: 9 | test: 10 | runs-on: ubuntu-latest 11 | strategy: 12 | matrix: 13 | python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] 14 | steps: 15 | - uses: actions/checkout@v4 16 | - name: Set up Python ${{ matrix.python-version }} 17 | uses: actions/setup-python@v5 18 | with: 19 | python-version: ${{ matrix.python-version }} 20 | cache: pip 21 | cache-dependency-path: pyproject.toml 22 | - name: Install dependencies 23 | run: | 24 | pip install '.[test]' 25 | - name: Run tests 26 | run: | 27 | python -m pytest 28 | 29 | -------------------------------------------------------------------------------- /tests/test_project/settings.py: -------------------------------------------------------------------------------- 1 | import djp 2 | import tempfile 3 | import os 4 | 5 | tempdir = tempfile.TemporaryDirectory() 6 | test_db = os.path.join(tempdir.name, "test.db") 7 | 8 | SECRET_KEY = "django-insecure-test-key" 9 | DEBUG = True 10 | ALLOWED_HOSTS = ["*"] 11 | 12 | INSTALLED_APPS = [ 13 | "django.contrib.admin", 14 | "django.contrib.auth", 15 | "django.contrib.contenttypes", 16 | "django.contrib.sessions", 17 | "django.contrib.messages", 18 | ] 19 | 20 | MIDDLEWARE = [] 21 | 22 | ROOT_URLCONF = "tests.test_project.urls" 23 | 24 | DATABASES = { 25 | "default": { 26 | "ENGINE": "django.db.backends.sqlite3", 27 | "NAME": test_db, 28 | "TEST": { 29 | "NAME": test_db, 30 | }, 31 | } 32 | } 33 | 34 | TEMPLATES = [ 35 | { 36 | "BACKEND": "django.template.backends.django.DjangoTemplates", 37 | "APP_DIRS": True, 38 | } 39 | ] 40 | 41 | USE_TZ = True 42 | 43 | djp.settings(globals()) 44 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [project] 2 | name = "django-plugin-datasette" 3 | version = "0.2" 4 | description = "Django plugin to run Datasette inside of Django" 5 | readme = "README.md" 6 | authors = [{name = "Simon Willison"}] 7 | license = {text = "Apache-2.0"} 8 | classifiers = [ 9 | "License :: OSI Approved :: Apache Software License" 10 | ] 11 | dependencies = [ 12 | "django", 13 | "djp>=0.3", 14 | "datasette", 15 | ] 16 | 17 | [project.urls] 18 | Homepage = "https://github.com/simonw/django-plugin-datasette" 19 | Changelog = "https://github.com/simonw/django-plugin-datasette/releases" 20 | Issues = "https://github.com/simonw/django-plugin-datasette/issues" 21 | CI = "https://github.com/simonw/django-plugin-datasette/actions" 22 | 23 | [project.entry-points.djp] 24 | django_plugin_datasette = "django_plugin_datasette" 25 | 26 | [project.entry-points.datasette] 27 | django_plugin_datasette = "django_plugin_datasette" 28 | 29 | [tool.setuptools.package-data] 30 | "*" = ["*.html", "*.js", "*.css"] 31 | 32 | [project.optional-dependencies] 33 | test = ["pytest", "pytest-django", "pytest-asyncio", "httpx"] 34 | 35 | [tool.pytest.ini_options] 36 | DJANGO_SETTINGS_MODULE = "tests.test_project.settings" 37 | pythonpath = ["."] 38 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Python Package 2 | 3 | on: 4 | release: 5 | types: [created] 6 | 7 | permissions: 8 | contents: read 9 | 10 | jobs: 11 | test: 12 | runs-on: ubuntu-latest 13 | strategy: 14 | matrix: 15 | python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] 16 | steps: 17 | - uses: actions/checkout@v4 18 | - name: Set up Python ${{ matrix.python-version }} 19 | uses: actions/setup-python@v5 20 | with: 21 | python-version: ${{ matrix.python-version }} 22 | cache: pip 23 | cache-dependency-path: pyproject.toml 24 | - name: Install dependencies 25 | run: | 26 | pip install '.[test]' 27 | - name: Run tests 28 | run: | 29 | python -m pytest 30 | deploy: 31 | runs-on: ubuntu-latest 32 | needs: [test] 33 | environment: release 34 | permissions: 35 | id-token: write 36 | steps: 37 | - uses: actions/checkout@v4 38 | - name: Set up Python 39 | uses: actions/setup-python@v5 40 | with: 41 | python-version: "3.12" 42 | cache: pip 43 | cache-dependency-path: pyproject.toml 44 | - name: Install dependencies 45 | run: | 46 | pip install setuptools wheel build 47 | - name: Build 48 | run: | 49 | python -m build 50 | - name: Publish 51 | uses: pypa/gh-action-pypi-publish@release/v1 52 | 53 | -------------------------------------------------------------------------------- /tests/test_django_plugin_datasette.py: -------------------------------------------------------------------------------- 1 | from asgiref.sync import sync_to_async 2 | import pytest 3 | from django.core.asgi import get_asgi_application 4 | from django.contrib.auth.models import User 5 | from djp import asgi_wrapper 6 | from django.test.client import Client 7 | import httpx 8 | 9 | 10 | @pytest.mark.django_db 11 | def test_index_page_200(): 12 | response = Client().get("/") 13 | assert response.status_code == 200 14 | 15 | 16 | @pytest.mark.asyncio 17 | @pytest.mark.django_db 18 | async def test_asgi_wrapper(): 19 | application = get_asgi_application() 20 | wrapped_application = asgi_wrapper(application) 21 | 22 | await sync_to_async(User.objects.create)(username="test", password="test") 23 | 24 | async with httpx.AsyncClient( 25 | transport=httpx.ASGITransport(app=wrapped_application), 26 | base_url="http://testserver", 27 | ) as client: 28 | response = await client.get("http://testserver/-/datasette/") 29 | assert response.status_code == 200 30 | assert "Datasette: test" in response.text 31 | 32 | users = ( 33 | await client.get( 34 | "http://testserver/-/datasette/test/auth_user.json?_shape=array" 35 | ) 36 | ).json() 37 | user = users[0] 38 | # password column must be null 39 | assert user["username"] == "test" 40 | assert user["password"] is None 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # django-plugin-datasette 2 | 3 | [![PyPI](https://img.shields.io/pypi/v/django-plugin-datasette.svg)](https://pypi.org/project/django-plugin-datasette/) 4 | [![Changelog](https://img.shields.io/github/v/release/simonw/django-plugin-datasette?include_prereleases&label=changelog)](https://github.com/simonw/django-plugin-datasette/releases) 5 | [![Tests](https://github.com/simonw/django-plugin-datasette/workflows/Test/badge.svg)](https://github.com/simonw/django-plugin-datasette/actions?query=workflow%3ATest) 6 | [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/django-plugin-datasette/blob/main/LICENSE) 7 | 8 | Run [Datasette](https://datasette.io/) inside Django as a [DJP](https://djp.readthedocs.io/) plugin 9 | 10 | ## Installation 11 | 12 | First configure your Django project [to use DJP](https://djp.readthedocs.io/en/latest/installing_plugins.html). Be sure to configure your `asgi.py` file. 13 | 14 | Then install this plugin in the same environment as your Django application. 15 | ```bash 16 | pip install django-plugin-datasette 17 | ``` 18 | ## Usage 19 | 20 | Once installed, `/-/datasette/` will serve a Datasette instance that exposes the contents of any SQLite databases used by Django. 21 | 22 | You will need to run Django using ASGI. One way to do that is with [Uvicorn](https://www.uvicorn.org/): 23 | 24 | ```bash 25 | pip install uvicorn 26 | uvicorn myproject.asgi:application 27 | ``` 28 | 29 | **Warning:** This will expose your entire Django database to anyone who visits `/-/datasette/`. The `auth_user.password` field is automatically redacted, but you should still take care that this does not expose any other sensitive information. 30 | 31 | ## Development 32 | 33 | To set up this plugin locally, first checkout the code. Then create a new virtual environment: 34 | ```bash 35 | cd django-plugin-datasette 36 | python -m venv venv 37 | source venv/bin/activate 38 | ``` 39 | Now install the dependencies and test dependencies: 40 | ```bash 41 | pip install -e '.[test]' 42 | ``` 43 | To run the tests: 44 | ```bash 45 | python -m pytest 46 | ``` 47 | -------------------------------------------------------------------------------- /django_plugin_datasette/__init__.py: -------------------------------------------------------------------------------- 1 | import djp 2 | import datasette 3 | from datasette.utils import sqlite3 4 | 5 | 6 | ds = None 7 | 8 | 9 | def get_ds(): 10 | from datasette.app import Datasette 11 | 12 | global ds 13 | if ds is None: 14 | from django.conf import settings 15 | 16 | dbs = [] 17 | for database in settings.DATABASES.values(): 18 | if database["ENGINE"] == "django.db.backends.sqlite3": 19 | dbs.append(str(database["NAME"])) 20 | ds = Datasette( 21 | dbs, 22 | settings={ 23 | "base_url": "/-/datasette/", 24 | }, 25 | ).app() 26 | return ds 27 | 28 | 29 | def redact_password(action, table, column, db_name, trigger_name): 30 | if action != sqlite3.SQLITE_READ: 31 | return sqlite3.SQLITE_OK 32 | if table == "auth_user" and column == "password": 33 | return sqlite3.SQLITE_IGNORE 34 | else: 35 | return sqlite3.SQLITE_OK 36 | 37 | 38 | @datasette.hookimpl 39 | def prepare_connection(conn, database, datasette): 40 | conn.set_authorizer(redact_password) 41 | 42 | 43 | @djp.hookimpl 44 | def asgi_wrapper(): 45 | return wrap 46 | 47 | 48 | def wrap(app): 49 | async def wrapper(scope, receive, send): 50 | await datasette_hello_world_wrapper(scope, receive, send, app) 51 | 52 | return wrapper 53 | 54 | 55 | async def datasette_hello_world_wrapper(scope, receive, send, app): 56 | if scope["type"] == "http" and scope["path"] == "/-/datasette": 57 | # Redirect 58 | await send( 59 | { 60 | "type": "http.response.start", 61 | "status": 302, 62 | "headers": [ 63 | [b"location", b"/-/datasette/"], 64 | ], 65 | } 66 | ) 67 | await send( 68 | { 69 | "type": "http.response.body", 70 | "body": b"", 71 | } 72 | ) 73 | return 74 | if scope["type"] == "http" and scope["path"].startswith("/-/datasette/"): 75 | ds = get_ds() 76 | await ds(scope, receive, send) 77 | else: 78 | await app(scope, receive, send) 79 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------