datasette-expose-env by simonw

5 downloads this week        Star

README

datasette-expose-env

PyPI Changelog Tests License

Datasette plugin to expose selected environment variables at /-/env for debugging

Installation

Install this plugin in the same environment as Datasette.

datasette install datasette-expose-env

Configuration

Decide on a list of environment variables you would like to expose, then add the following to your metadata.yml configuration:

plugins:
    datasette-expose-env:
    - ENV_VAR_1
    - ENV_VAR_2
    - ENV_VAR_3

If you are using JSON in a metadata.json file use the following:

{
    "plugins": {
        "datasette-expose-env": [
            "ENV_VAR_1",
            "ENV_VAR_2",
            "ENV_VAR_3"
        ]
    }
}

Visit /-/env on your Datasette instance to see the values of the environment variables.

Development

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

cd datasette-expose-env
python3 -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest