Skip to main content

Plugin allowing Datasette templates to be edited within Datasette

Project description

datasette-edit-templates

PyPI Changelog Tests License

Plugin allowing Datasette templates to be edited within Datasette.

Installation

Install this plugin in the same environment as Datasette.

datasette install datasette-edit-templates

Usage

On startup. a _templates_ table will be created in the database you are running Datasette against.

Use the app menu to navigate to the /-/edit-templates page, and edit templates there.

Changes should become visible instantly, and will be persisted to your database.

The interface is only available to users with the edit-templates permission.

The root user is granted this permission by default. You can sign in as the root user using datasette mydb.db --root.

Configuration

To put the _templates_ table in a specific database, set the datasette-edit-templates: database plugin configuration option:

{
    "plugins": {
        "datasette-edit-templates": {
            "database": "some_database"
        }
    }
}

On Datasette 1.0a5 or higher you can use the internal database with "internal_db: true":

{
    "plugins": {
        "datasette-edit-templates": {
            "internal_db": true
        }
    }
}

By default the prepare_jinja2_environment() hook will be used to load the custom templates.

You can disable this behavior using the skip_prepare_jinja2_environment plugin configuration option:

{
    "plugins": {
        "datasette-edit-templates": {
            "skip_prepare_jinja2_environment": true
        }
    }
}

Set this option if you want to further customize how the templates are loaded using another plugin.

The menu item used to access this plugin is labeled "Edit templates" by default. You can customize this using the menu_label plugin configuration option:

{
    "plugins": {
        "datasette-edit-templates": {
            "menu_label": "Custom templates"
        }
    }
}

Set that to null to hide the menu option entirely.

Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

cd datasette-edit-templates
python3 -mvenv venv
source venv/bin/activate

Or if you are using pipenv:

pipenv shell

Now install the dependencies and tests:

pip install -e '.[test]'

To run the tests:

pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datasette-edit-templates-0.4.3.tar.gz (84.3 kB view details)

Uploaded Source

Built Distribution

datasette_edit_templates-0.4.3-py3-none-any.whl (82.9 kB view details)

Uploaded Python 3

File details

Details for the file datasette-edit-templates-0.4.3.tar.gz.

File metadata

File hashes

Hashes for datasette-edit-templates-0.4.3.tar.gz
Algorithm Hash digest
SHA256 ad34eb90235e08b9883ce4262875d1d07d7564119e1fb9321ef595b9fd484157
MD5 35806850c488d3dfa6ccec2ce4b56fbd
BLAKE2b-256 9e8beb6de2d0dfb711e4374b6af88e2e371714c02ebc6b147a2f939a2f5447dc

See more details on using hashes here.

File details

Details for the file datasette_edit_templates-0.4.3-py3-none-any.whl.

File metadata

File hashes

Hashes for datasette_edit_templates-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6fcb5b400d8f8cde0eba2781bfab8ba444a457fed32176fed5d62dece7ed2e8e
MD5 0538d8f2ea346bc7f66f25f9e0d4ba33
BLAKE2b-256 82d17c8ecd3d4f96c0637894ab64f363987c5b0533e336b5dcb328ab7f1c24d3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page