Metadata-Version: 2.1
Name: datasette-init
Version: 0.1a3
Summary: Ensure specific tables and views exist on startup
Home-page: https://github.com/simonw/datasette-init
Author: Simon Willison
License: Apache License, Version 2.0
Project-URL: Issues, https://github.com/simonw/datasette-init/issues
Project-URL: CI, https://github.com/simonw/datasette-init/actions
Project-URL: Changelog, https://github.com/simonw/datasette-init/releases
Description: # datasette-init
        
        [![PyPI](https://img.shields.io/pypi/v/datasette-init.svg)](https://pypi.org/project/datasette-init/)
        [![Changelog](https://img.shields.io/github/v/release/simonw/datasette-init?label=changelog)](https://github.com/simonw/datasette-init/releases)
        [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-init/blob/master/LICENSE)
        
        Ensure specific tables and views exist on startup
        
        ## Installation
        
        Install this plugin in the same environment as Datasette.
        
            $ pip install datasette-init
        
        ## Usage
        
        This plugin is configured using `metadata.json` (or `metadata.yaml`). 
        
        ### Creating tables
        
        Add a block like this that specifies the tables you would like to ensure exist:
        
        ```json
        {
          "plugins": {
            "datasette-init": {
              "my_database": {
                "tables": {
                  "dogs": {
                    "columns": {
                      "id": "integer",
                      "name": "text",
                      "age": "integer",
                      "weight": "float",
                    },
                    "pk": "id"
                  }
                }
              }
            }
          }
        }
        ```
        
        Any tables that do not yet exist will be created when Datasette first starts.
        
        Valid column types are `"integer"`, `"text"`, `"float"` and `"blob"`.
        
        The `"pk"` is optional, and is used to define the primary key. To define a compound primary key (across more than one column) use a list of column names here:
        ```json
            "pk": ["id1", "id2"]
        ```
        
        ### Creating views
        
        The plugin can also be used to create views:
        
        ```json
        {
          "plugins": {
            "datasette-init": {
              "my_database": {
                "views": {
                  "my_view": "select 1 + 1"
                }
              }
            }
          }
        }
        ```
        
        Each view in the ``"views"`` block will be created when the Database first starts. If a view with the same name already exists it will be replaced with the new definition.
        
        
        ## Development
        
        To set up this plugin locally, first checkout the code. Then create a new virtual environment:
        
            cd datasette-init
            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
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: test
