A simple cookiecutter template to bootstrap a pretalx plugin.
Let's pretend you want to create a pretalx plugin called "foobar".
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:
[1/7] human_name (pretalx FooBar plugin): pretalx JSON plugin [2/7] module_name (pretalx_json): [3/7] short_description (pretalx plugin for pretalx JSON plugin): pretalx plugin for custom JSON exports [4/7] author_name (Your name): Tobias Kunze [5/7] author_email ([email protected]): [email protected] [6/7] repo_url (https://github.com/r/pretalx-json): https://github.com/rixx/pretalx-json [7/7] Select category 1 - FEATURE 2 - INTEGRATION 3 - CUSTOMIZATION 4 - EXPORTER 5 - RECORDING 6 - LANGUAGE 7 - OTHER Choose from [1/2/3/4/5/6/7] (1): 1
Now, change to the newly created directory:
$ cd pretalx-foobar
Voilà, there's your plugin structure! See pretalx' documentation for more info.