https://github.com/next-li/datasette-surveys

Construct and gather responses to surveys all within Datasette
https://github.com/next-li/datasette-surveys

alpaca datasette datasette-live datasette-plugin

Last synced: 24 days ago
JSON representation

Construct and gather responses to surveys all within Datasette

• Host: GitHub
• URL: https://github.com/next-li/datasette-surveys
• Owner: next-LI
• License: apache-2.0
• Created: 2021-04-28T07:16:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-17T15:28:54.000Z (over 3 years ago)
• Last Synced: 2024-11-24T16:18:12.049Z (about 1 month ago)
• Topics: alpaca, datasette, datasette-live, datasette-plugin
• Language: JavaScript
• Homepage:
• Size: 131 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# datasette-surveys

Construct and gather responses to surveys all within Datasette!

![Here's what the survey form builder looks like](https://github.com/next-LI/datasette-surveys/blob/main/screenshot.png)

This plugin is based heavily on the officially amazing but unsupported [Alpaca form builder](http://www.alpacajs.org/demos/form-builder/form-builder.html).

## Installation

Using pypi:

    pip install datasette-surveys

Or locally:

    python setup.py install

Note: You can't install this package via GitHub! You need to use one of the above methods.

## Usage

The plugin adds an interface at `/-/surveys` and a "Surveys" link in the menu.

## Configuration & Permissions

This plugin uses the permission plugin looking for responses to the following actions (they all start with `surveys-`):

- `surveys-list`: allows actors to view the list of previously created surveys.

- `surveys-create`: allows actors to create surveys. Won't allow overwriting by itself.

- `surveys-update`: allows actors to update surveys, _resource_: id of the survey if being updated. This permission doesn't stop actors from updating with blank surveys or otherwise removing fields.

- `surveys-delete`: allows actors to delete surveys. _resource_: id of the survey being deleted.

- `surveys-view-form`: allows actors to view and respond to individual forms. _resource_: id of the survey.

One configuration option is available, which controls which directory the surveys folder will be placed.

    # in your metadata.yml...

    plugins:

      datasette-surveys:

        db_dir: /path/to/data

By default, the current working directory for the Datasette process will be used (assumed to be the same as the other DBs).

## Development

The form builder borrows heavily from [Alpaca's form builder](http://www.alpacajs.org/demos/form-builder/form-builder.html) and the front end build also comes from the Alpaca repo.

To pull the dependencies for the plugin, use bower:

    bower install

And if you don't have bower, run this first: `npm install -g bower`

The form builder is found in `datasette_surveys/static/form-builder.js`. It's a modified version of the Alpaca one.

Running `python setup.py install` will reinstall the plugin.

If you're in control of the pypi package, and you're ready to deploy a new version, you need to do the following:

    python setup.py sdist

    twine upload dist/*

You can only upload a version once, so make sure there's no bugs. :P