ftw.profilehook 1.3.0

A Plone addon providing a hook for executing code when a generic setup profile is installed.

ftw.profilehook

ftw.profilehook provides a hook for executing custom code after a generic setup profile is installed.

Motivation

We often use import steps for executing code after import a generic setup profile. Registering a lot of setup handlers is bad because it extends the import duration of every profile and the amount of import steps are limited in generic setup, causing bad effects when exceeded. Import steps are meant to import things from any profile, not for executing code after importing a specific profile. Because of these reasons ftw.profilehook exists and provides an easy method to solve this issue.

Usage

Add ftw.profilehook as dependency in your setup.py:

setup(...
      install_requires=['ftw.profilehook'])

Register your hook function in ZCML (configure.zcml):

<configure
    xmlns="http://namespaces.zope.org/zope"
    xmlns:genericsetup="http://namespaces.zope.org/genericsetup"
    xmlns:i18n="http://namespaces.zope.org/i18n"
    xmlns:profilehook="http://namespaces.zope.org/profilehook"
    i18n_domain="my.package">

  <include package="ftw.profilehook" />

  <genericsetup:registerProfile
      name="default"
      title="my.package"
      directory="profiles/default"
      provides="Products.GenericSetup.interfaces.EXTENSION"
      />

  <profilehook:hook
      profile="my.package:default"
      handler=".hooks.default_profile_installed"
      />

</configure>

Do things in your hook (hooks.py):

from my.package.interfaces import IMyRoot
from zope.component import alsoProvides


def default_profile_installed(site):
  mark_site_as_my_root(site)


def mark_site_as_my_root(site)
  if not IMyRoot.providedBy(site):
    alsoProvides(site, IMyRoot)

After your profile (my.package:default) is installed, your hook is executed.

Before-Import Hook

The standard hook (profilehook:hook) is executed after importing the profile. By using the profilehook:before_import_hook directive, you can register hooks which are executed before importing the profile.

<profilehook:before_import_hook
    profile="my.package:default"
    handler=".hooks.before_installing_default_profile"
    />

Links

• Github: https://github.com/4teamwork/ftw.profilehook

• Pypi: http://pypi.python.org/pypi/ftw.profilehook

• Tests: https://jenkins.4teamwork.ch/search?q=ftw.profilehook

Copyright

This package is copyright by 4teamwork.

ftw.profilehook is licensed under GNU General Public License, version 2.

Changelog

1.3.0 (2018-09-28)

• Fix error when uploading a tarball in portal_setup. [jone]

• Add plone 5.1.x test cfg. [mathias.leimgruber]

1.2.1 (2016-05-12)

• Fix compatibility with ftw.inflator. [jone]

1.2.0 (2016-05-11)

• Support before-import hooks. [jone]

1.0.0 (2014-08-15)

• Initial implementation. [jone]