pretalx-plugin-cookiecutter

A simple cookiecutter template to bootstrap a pretalx plugin.

Usage

Let's pretend you want to create a pretalx plugin called "superplugin". First, create a virtual environment and install the cookiecutter package using pip. Next, use it to bootstrap your project folder:

$ cd <your-project-folder-parent>
$ cookiecutter https://github.com/pretalx/pretalx-plugin-cookiecutter

You'll be prompted for some questions. Answer them, and you will find a project folder created for you:

repo_name [pretalx-superplugin]: pretalx-superplugin
repo_url [GitHub repository URL]: https://github.com/myuser/pretalx-superplugin
module_name [pretalx_superplugin]: pretalx_superplugin
human_name [The pretalx super plugin]: Super Plugin
author_name [Your name]: J Random Developer
author_email [Your email]: jrandom@example.org
year [Current year]: 2017
short_description [Short description]: The best plugin

Now, change to the newly created directory:

$ cd pretalx-superplugin

Voilà, there's your plugin structure! See pretalx' documentation for more info.