bobtemplates.eea 4.0.5

Templates for Plone projects.

bobtemplates.eea provides mr.bob templates to generate packages for EEA projects.

This is a custom fork of bobtemplates.plone

Features

Package created with bobtemplates.eea use the current best-practices when creating an add-on. It also support’s GIT by default, to keep track of changes one is doing with the bobtemplates.

Provided templates

• addon

• buildout

Provided subtemplates

These templates are meant to be used inside a package which was created by the addon template.

• behavior

• content_type

• restapi_service

• theme

• theme_barceloneta

• view

• viewlet

• vocabulary

Compatibility

Add-ons created with bobtemplates.eea are tested to work in Plone 4.3.x and Plone 5. They should also work with older versions but that was not tested. It should work on Linux, Mac and Windows.

Installation

You can install bobtemplates.eea as every other normal Python package with pip inside a virtualenv or better with pipenv.

Installion with pipenv

pipenv install bobtemplates.eea

Installation with pip in a virtualenv

You can also install bobtemplates.eea with pip in a virtualenv. If you don’t have an active virtualenv, you can create one inside your project directory.

virtualenv .

Then either activate the virtualenv:

source ./bin/activate

or just use the binaries directly inside the bin folder as below:

./bin/pip install bobtemplates.eea

Use in a buildout

[buildout]
parts += mrbob

[mrbob]
recipe = zc.recipe.egg
eggs =
    mr.bob
    bobtemplates.eea

This creates a mrbob-executable in your bin-directory.

Usage

As bobtemplates.eea is a template for mr.bob, we use mrbob to run the templates.

If you are using buildout or an unactivated virtualenv, you can use mrbob like this:

./bin/mrbob bobtemplates.eea:addon -O src/eea.foo

If you are using pipenv or an activated virtualenv, you can use mrbob like this:

Activate pipenv shell:

pipenv shell

or activate your virtualenv:

source bin/activate

mrbob bobtemplates.eea:addon -O src/eea.foo

This will create your Plone package inside the src directory.

See the documentation of mr.bob for further information.

Configuration

You can set all mr.bob configuration parameters in your ~/.mrbob file.

Here is an example:

[mr.bob]
verbose = False

[variables]
author.name = Alin Voinea
author.email = [e-mail]
author.github.user = avoinea
plone.version = 4.3
#package.git.init = y
#package.git.autocommit = n
#package.git.disabled = n

[defaults]
dexterity_type_global_allow = n
dexterity_type_filter_content_types = y
dexterity_type_activate_default_behaviors = n
dexterity_type_supermodel = n

Contribute

• Issue Tracker: https://github.com/eea/bobtemplates.eea/issues

• Source Code: https://github.com/eea/bobtemplates.eea

• Documentation: https://docs.plone.org/develop/addons/bobtemplates.plone/docs/ or https://bobtemplatesplone.readthedocs.io/en/latest/

Support

If you are having issues, please let us know. We have a Gitter channel here: plone/bobtemplates.plone

Contributors

This package was originally based on bobtemplates.niteoweb and bobtemplates.ecreall

• Maik Derstappen [MrTango]

• 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]

• Johannes Raggam [thet]

• Sven Strack [svx]

• Héctor Velarde [hvelarde]

• Aurore Mariscal [AuroreMariscal]

• Víctor Fernández de Alba [sneridagh]

• Alexander Loechel [loechel]

Changelog

4.0.5 (2020-12-03)

• Change: Modified addon template so that you can now create packages with 2 namespaces e.g. eea.foo.bar [iulianpetchesi]

4.0.5rc5 (2020-11-25)

• Cleanup: Fix pylint, pep8 [avoinea]

4.0.5rc4 (2020-11-25)

• Cleanup: Remove CasperJS functional tests [avoinea]

4.0.5rc3 (2020-09-02)

• Cleanup: Update Jenkinsfile and setup.py [avoinea]

4.0.5rc2 (2019-05-09)

• Bug fix: Fix addon setup.py.bob syntax [avoinea]

4.0.5.rc1 (2019-05-09)

• Initial release based on bobtemplates.plone 4.0.5 [avoinea]