Introduction

bobtemplates.cs provides a mr.bob template to generate a buildout package for Plone projects.

Installation

Use in a buildout

[buildout]
parts += mrbob

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

This creates a mrbob-executable in your bin-directory. Call it from the src-directory of your Plone project like this.

../bin/mrbob -O collective.foo bobtemplates:cs_plone_buildout

Installation in a virtualenv

You can also install bobtemplates.cs in a virtualenv.

pip install bobtemplates.cs

With pip 6.0 or newer mr.bob will automatically be installed as a dependency. If you still use a older version of pip you need install mr.bob before bobtemplates.cs.

pip install mr.bob

Now you can use it like this

mrbob -O collective.foo bobtemplates:cs_plone_buildout

See mr.bob documentation for further information.

https://travis-ci.com/codesyntax/bobtemplates.cs.svg?branch=master Coveralls Latest Version Documentation Status License

bobtemplates.cs

bobtemplates.cs provides a mr.bob template to generate packages for Plone projects using our customizations. This packages is based on bobtemplates.plone

Features

Package created with bobtemplates.cs use the current best-practices when creating an add-on.

Provided templates

  • cs_plone_buildout
  • cs_migration

This template provides a ready-to-use buildout template for Plone sites. It asks for a Plone version and configures the buildout with it.

The generated buildout provides configuration files for nginx and Apache, haproxy, varnish and logrotate.

It also creates cron jobs to pack your database and to restart the services when the server is rebooted.

This template adds some useful blueprints and a pipeline for a Transmogrifier based migration for Plone 5.

The provided pipeline will work with a collective.jsonify export out of the box.

We have been using the blueprints and the pipeline in several projects and found them very useful. To make the pipeline work correctly, you will need to adjust the created migration1.cfg file to provide the path of the export and adjust one or two parameters.

To get started with Transmogrifier, visit the training at https://training.plone.org/5/transmogrifier

You can run the migration from the command line, using the provided zopectl scripts, as follows. Inspect all the registered transmogrifier pipelines:

$ cd /path/to/your/buildout
$ ./bin/instance list_migrations

Run the selected pipeline:

$ cd /path/to/your/buildout
$ ./bin/instance run_migration my.package-step1

Compatibility

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

Documentation

Full documentation for end users can be found in the “docs” folder.

Support

If you are having issues, please let us know.

plonecli

plonecli is a helper to for developing Plone packages and helps using mr.bob based templates present on `bobtemplates.plone`_.

The templates provided by us at bobtemplates.cs are also available on plonecli, so you can use them easily:

$ pip install plonecli
$ plonecli --list-templates
 Available mr.bob templates:
 - theme_package
 - buildout
 - addon
 - view
 - vocabulary
 - content_type
 - viewlet
 - behavior
 - theme_barceloneta
 - portlet
 - theme
 - cs_plone_buildout

And use it:

$ plonecli create cs_plone_buildout myproject

Indices and tables