datasette-upload-dbs by simonw
204 downloads this week Star
README source code
Upload SQLite database files to Datasette
Install this plugin in the same environment as Datasette.
datasette install datasette-upload-dbs
This plugin requires you to configure a directory in which uploaded files will be stored.
On startup, Datasette will automatically load any SQLite files that it finds in that directory. This means it is safe to restart your server in between file uploads.
To configure the directory as /home/datasette/uploads
, add this to a metadata.yml
configuration file:
plugins:
datasette-upload-dbs:
directory: /home/datasette/uploads
Or if you are using metadata.json
:
{
"plugins": {
"datasette-upload-dbs": {
"directory": "/home/datasette/uploads"
}
}
}
You can use "."
for the current folder when the server starts, or "uploads"
for a folder relative to that folder. The folder will be created on startup if it does not already exist.
Then start Datasette like this:
datasette -m metadata.yml
The plugin defaults to loading all databases in the configured directory.
You can disable this by adding the following setting:
"skip_startup_scan": true
Only users with the upload-dbs
permission will be able to upload files. The root
user has this permission by default - other users can be granted access using permission plugins, see the Permissions documentation for details.
To start Datasette as the root user, run this:
datasette -m metadata.yml --root
And follow the link that is displayd on the console.
If a user has that permission they will see an "Upload database" link in the navigation menu.
This will take them to /-/upload-dbs
where they will be able to upload database files, by selecting them or by dragging them onto the drop area.
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
cd datasette-upload-dbs
python3 -m venv venv
source venv/bin/activate
Now install the dependencies and test dependencies:
pip install -e '.[test]'
To run the tests:
pytest