https://github.com/simonw/datasette-template-request

Expose the Datasette request object to custom templates
https://github.com/simonw/datasette-template-request

datasette datasette-io datasette-plugin

Last synced: 27 days ago
JSON representation

Expose the Datasette request object to custom templates

• Host: GitHub
• URL: https://github.com/simonw/datasette-template-request
• Owner: simonw
• Created: 2021-09-23T17:07:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-23T17:29:36.000Z (over 3 years ago)
• Last Synced: 2024-10-18T07:53:59.929Z (3 months ago)
• Topics: datasette, datasette-io, datasette-plugin
• Language: Python
• Homepage: https://datasette.io/plugins/datasette-template-request
• Size: 5.86 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# datasette-template-request

[![PyPI](https://img.shields.io/pypi/v/datasette-template-request.svg)](https://pypi.org/project/datasette-template-request/)

[![Changelog](https://img.shields.io/github/v/release/simonw/datasette-template-request?include_prereleases&label=changelog)](https://github.com/simonw/datasette-template-request/releases)

[![Tests](https://github.com/simonw/datasette-template-request/workflows/Test/badge.svg)](https://github.com/simonw/datasette-template-request/actions?query=workflow%3ATest)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-template-request/blob/main/LICENSE)

Expose the Datasette request object to custom templates

## Installation

Install this plugin in the same environment as Datasette.

    $ datasette install datasette-template-request

## Usage

Once this plugin is installed, Datasette [custom templates](https://docs.datasette.io/en/stable/custom_templates.html) can use `{{ request }}` to access the current [request object](https://docs.datasette.io/en/stable/internals.html#request-object). For example, to access `?name=Cleo` in the query string a template could use this:

    Name: {{ request.args.name }}

## Development

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

    cd datasette-template-request

    python3 -mvenv venv

    source venv/bin/activate

Or if you are using `pipenv`:

    pipenv shell

Now install the dependencies and test dependencies:

    pip install -e '.[test]'

To run the tests:

    pytest