FormShare Plugins Template

April 9, 2026 · View on GitHub

A Cookiecutter (project template) for creating FormShare plugins.

Requirements

Python 3.6
FormShare
cookiecutter

Usage

Generate a FormShare plugin project, following the prompts from the command
```
$ cookiecutter https://github.com/qlands/formshare-cookiecutter-plugin
```

Finish configuring the plugin by creating a virtual environment and installing your new project.

$ . ./formshare_virtual_env/bin/activate
$ cd myFormSharePlugin
$ python setup.py develop
# Create and apply an initial version of the DB for the plugin
$ mv alembic.example.ini alembic.ini
# Edit the alembic.ini an replace sqlalchemy.url with the one in the FormShare ini file
$ alembic revision --autogenerate -m "Initial version"
$ alembic upgrade head

Add the plugin to the FormShare list of plugins by editing the following line in development.ini or production.ini
```
    #formshare.plugins = examplePlugin
    formshare.plugins = myformshareplugin
```
Run FormShare