bobtemplates.plone provides a mr.bob template to generate packages for Plone projects.
To create a package like collective.myaddon:
$ mrbob -O collective.myaddon bobtemplates:plone_addon
You can also create a package with nested namespace:
$ mrbob -O collective.foo.myaddon bobtemplates:plone_addon
On creating a package you can choose from the following options. The default value is in [square brackets]:
- Author's name
- Should be something like 'John Smith'.
- Author's email
- Should be something like 'john@plone.org'.
- Author's github username
- Should be something like 'john'.
- Package description [An add-on for Plone]
- One-liner describing what this package does. Should be something like 'Plone add-on that ...'.
- Package keywords [Plone Python]
- Keywords/categoris describing this package. Should be something like 'Plone Python Diazo...'.
- Version of the package [0.1]
- Should be something like '0.1'.
- License of the package [GPL]
- Should be something like 'GPL'.
- Plone version [4.3.4]
- Which Plone version would you like to use?
- Add locales? [False]
- Do you want to add translations to this package?
- Add example view? [True]
- Do you want to register a browser view 'demoview' as an example?
- Use generic setup profile? [True]
- Do you want the package to have a generic setup profile? If you select False all following questions will be skipped.
- Add setuphandlers? [True]
- Do you want the package to have a setuphander.py to run cusotm code during install?
- Add a diazo-theme? [False]
- Do you want to add a empty theme using diazo/plone.app.theming to the package?
- Add tests? [True]
- Do you want to add a basic setup for tests, robot-tests and travis-integration?
- Prepare Travis Integration? [False]
- Should the package be prepared to be integrated into travis (http://travis-ci.org)? If you select False all following questions will be skipped.
- Type of Travis CI notifications [email]
- Should be something like 'email' or 'irc', see : http://about.travis-ci.org/docs/user/notifications for more information.
- Destination for Travis CI notifications
- Should be something like 'travis-reports@example.com' or 'irc.freenode.org#plone'.
Addons created with bobtemplates.plone are tested to work in Plone 4.3.x and Plone 5.
They should also work with older versions but that was not tested.
[buildout]
parts += mrbob
[mrbob]
recipe = zc.recipe.egg
eggs =
mr.bob
bobtemplates.plone
This creates a mrbob-executeable in your bin-directory.
Call it from the src-directory of your Plone project like this.:
$ ../bin/mrbob -O collective.foo bobtemplates:plone_addon
You can also install bobtemplates.plone in a virtualenv.:
$ pip install mr.bob $ pip install bobtemplates.plone
Now you can use it like this:
$ mrbob -O collective.foo bobtemplates:plone_addon
See mr.bob documentation for further information : http://mrbob.readthedocs.org/en/latest/