https://github.com/pretix/pretix-plugin-cookiecutter

Cookiecutter template for pretix plugins
https://github.com/pretix/pretix-plugin-cookiecutter

cookiecutter django pretix

Last synced: about 1 year ago
JSON representation

Cookiecutter template for pretix plugins

• Host: GitHub
• URL: https://github.com/pretix/pretix-plugin-cookiecutter
• Owner: pretix
• Created: 2017-01-07T17:56:35.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-08-06T07:07:44.000Z (almost 2 years ago)
• Last Synced: 2024-08-06T09:03:41.067Z (almost 2 years ago)
• Topics: cookiecutter, django, pretix
• Language: Shell
• Size: 35.2 KB
• Stars: 2
• Watchers: 6
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
pretix-plugin-cookiecutter

==========================

A simple `cookiecutter`_ template to bootstrap a `pretix`_ plugin.

Usage

-----

Let's pretend you want to create a pretix plugin called "superplugin".

First, create a virtual environment and install the ``cookiecutter``

package using pip. Next, use it to bootstrap your project folder::

    $ cd 

    $ cookiecutter https://github.com/pretix/pretix-plugin-cookiecutter

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

project folder created for you::

    repo_name [pretix-superplugin]: pretix-superplugin

    repo_url [GitHub repository URL]: https://github.com/myuser/pretix-superplugin

    module_name [pretix_superplugin]: pretix_superplugin

    human_name [The pretix super plugin]: Super Plugin

    author_name [Your name]: J Random Developer

    author_email [Your email]: jrandom@example.org

    short_description [Short description]: The best plugin

    Select license:

    1 - Apache

    2 - pretix Enterprise

    Choose from 1, 2 [1]: 1

    min_basever [2.7.0]: 2.7.0

    Select category:

    1 - FEATURE

    2 - PAYMENT

    3 - INTEGRATION

    4 - CUSTOMIZATION

    5 - FORMAT

    6 - API

    Choose from 1, 2, 3, 4, 5, 6 [1]: 1

Now, change to the newly created directory::

    $ cd pretix-superplugin

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

.. _pretix: https://github.com/pretix/pretix

.. _cookiecutter: https://github.com/audreyr/cookiecutter

.. _documentation: https://docs.pretix.eu/en/latest/development/api/plugins.html#pluginsetup