bobtemplates.plone 0.7

Templates for Plone projects.

Introduction

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

Options

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 ‘[e-mail]’.

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 ‘[e-mail]’ or ‘irc.freenode.org#plone’.

Compatibility

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.

Installation

Use in a buildout

[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

Installation in a virtualenv

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/

Contributors

This package is based on bobtemplates.niteoweb and bobtemplates.ecreall

• Philip Bauer [pbauer]

• Cédric Messiant [cedricmessiant]

• Vincent Fretin [vincentfretin]

• Thomas Desvenain [thomasdesvenain]

• Domen Kožar [iElectric]

• Nejc Zupan [zupo]

• Patrick Gerken [do3cc]

• Timo Stollenwerk [timo]

Changelog

0.7 (2015-02-05)

• Use latest buildout-bootstrap.py. [timo]

• Fix failing nosetests. [timo]

• Add test that creates an add_on and runs all its tests and code analysis. [timo]

• Run tests on travis. [timo]

• Run code analysis on travis. Build fails on PEP8 violations. [timo]

• Add code analysis. [timo]

• Remove z2.InstallProducts. Not needed any longer. [timo]

• Use testing best practices and follow common naming conventions. [timo]

• Remove testing profile. Global testing state is considered an anti-pattern. [timo]

• Add example robot test. [timo]

• Add travis and pypip.in badges. [timo]

• Run code analysis on the generated addon as well within the tests to make sure we always ship 100% PEP8 compliant code. [timo]

• Add REMOTE_LIBRARY_BUNDLE_FIXTURE to acceptance test fixture. [timo]

0.6 (2015-01-17)

• Use PLONE_APP_CONTENTTYPES_FIXTURE for tests on when using Plone 5. [pbauer]

0.5 (2015-01-17)

• Remove useless base-classes for tests. Use ‘layer = xxx’ instead. [pbauer]

• Fix some minor code-analysis issues. [pbauer]

• Added .editorconfig file. [ale-rt]

0.4 (2014-12-08)

• Remove grok. [pbauer]

• Fix missed removals when testing was deselected. [pbauer]

• Only use jbot when there is a profile and a browser layer. [pbauer]

• Get username and email from git. [do3cc]

0.3 (2014-12-07)

• Pinn robotframework to 2.8.4 to fix package-tests. [pbauer]

• Add browserlayer to demoview to allow multiple addons. [pbauer]

• Fix creation of nested packages (wrong __init__.py). [pbauer]

0.2 (2014-12-07)

• Fix documentation [pbauer]

0.1 (2014-12-07)

• Get namespace, name and type from target-dir. [pbauer]

• Remove obsolete plone_addon_nested. Auto-nest package in after-render hook. [pbauer]

• Add many new features. Most of them are optional. [pbauer]

• Initial import based on bobtemplates.ecreall by cedricmessiant, vincentfretin and thomasdesvenain. [pbauer]