Laying Pipe with Transmogrifier

Laying Pipe with Transmogriﬁer Clayton Parker, Senior Web Developer PLONE CONFERENCE 2010 Thursday, October 28, 2010

Who Am I? PLONE CONFERENCE 2010 • claytron • Python dev since 2003 • Plone Core Committer • Foundation Member Thursday, October 28, 2010

What Will We PLONE CONFERENCE 2010 Learn? • What is Transmogriﬁer • How to use it in Plone • How to package a migration Thursday, October 28, 2010

Migrations PLONE CONFERENCE 2010 • One off scripts • In multiple places • No re-use Thursday, October 28, 2010

Transmogriﬁer PLONE CONFERENCE 2010 • A framework for migrations • Re-usable parts Thursday, October 28, 2010

Basics PLONE CONFERENCE 2010 • Pipeline • Blueprints • Sources Thursday, October 28, 2010

Pipeline [transmogrifier] PLONE CONFERENCE 2010 pipeline = blog title text text-mimetype date type transitions urlnormalizer path constructor schemaupdate comment-insert comments workflow reindexobject [blog] blueprint = transmogrify.blogger filename = acost.policy.import:export.xml [title] blueprint = collective.transmogrifier.sections.manipulator keys = _transmogrify.blogger.title destination = string:title delete = ${title:keys} Thursday, October 28, 2010

Blueprints PLONE CONFERENCE 2010 • Python code • Packages Thursday, October 28, 2010

Sources PLONE CONFERENCE 2010 • A blueprint • First item in your pipeline Thursday, October 28, 2010

conﬁgure.zcml PLONE CONFERENCE 2010 <configure xmlns="http://namespaces.zope.org/zope"> <include package="collective.transmogrifier" /> <utility component=".blueprint.MySection" name="my.section" /> </configure> Thursday, October 28, 2010

blueprint.py PLONE CONFERENCE 2010 from zope.interface import implements from zope.interface import classProvides from collective.transmogrifier.interfaces import ISection from collective.transmogrifier.interfaces import ISectionBlueprint class MySection(object): """A blueprint for importing something into plone """ classProvides(ISectionBlueprint) implements(ISection) def __iter___(self): # add any other sources into the stream for item in self.previous: # Do something with each item # Pass it on to the next blueprint yield item Thursday, October 28, 2010

Items PLONE CONFERENCE 2010 • Each item is a mapping • Keys are ﬁelds • Keys with a leading underscore are controllers Thursday, October 28, 2010

Pipeline Settings PLONE CONFERENCE 2010 • Use annotations • Globally imported settings Thursday, October 28, 2010

GenericSetup PLONE CONFERENCE 2010 • Make migration part of your release • Ability to package migrations Thursday, October 28, 2010

Package Layout PLONE CONFERENCE 2010 my.migration !"" __init__.py !"" configure.zcml !"" import # !"" __init__.py # !"" configure.zcml # !"" my_items.csv # %"" my_migration.cfg %"" profiles %"" default %"" transmogrifier.txt Thursday, October 28, 2010

import/conﬁgure.zcml PLONE CONFERENCE 2010 <configure xmlns="http://namespaces.zope.org/zope" xmlns:transmogrifier="http://namespaces.plone.org/transmogrifier"> <include package="collective.transmogrifier"/> <include package="collective.transmogrifier" file="meta.zcml"/> <transmogrifier:registerConfig name="my_migration" title="Import items based on CSV file" description="" configuration="my_migration.cfg" /> </configure> Thursday, October 28, 2010

transmogriﬁer.txt PLONE CONFERENCE 2010 my_migration Thursday, October 28, 2010

Example Pipeline PLONE CONFERENCE 2010 [transmogrifier] pipeline = csv_file constructor schemaupdater [csv_file] blueprint = collective.transmogrifier.sections.csvsource filename = my.migration.import:my_items.csv [constructor] blueprint = collective.transmogrifier.sections.constructor [schemaupdater] blueprint = plone.app.transmogrifier.atschemaupdater Thursday, October 28, 2010

my_items.csv PLONE CONFERENCE 2010 _path,_type,title,description /folder1,Folder,First Folder,This is folder One /folder2,Folder,Second Folder,This is folder Two /folder1/foo,Document,One Foo,A document named foo /folder2/foo,Document,Two Foo,Another doc named foo Thursday, October 28, 2010

The Result PLONE CONFERENCE 2010 Thursday, October 28, 2010

Stock Blueprints PLONE CONFERENCE 2010 • Constructor section • Folders section • Codec section • Inserter section • Condition section • Manipulator section • Splitter section • Savepoint section • CSV source section Thursday, October 28, 2010

Useful Sources and PLONE CONFERENCE 2010 Blueprints • plone.app.transmogriﬁer • transmogrify.ﬁlesystem • transmogrify.sqlalchemy • transmogrify.webcrawler • wordpress / zine / blogger Thursday, October 28, 2010

plone.app.transmogriﬁer PLONE CONFERENCE 2010 • ATSchema updater section • UID updater section • Workﬂow updater section • Browser default section • Criterion adder section • Portal Transforms section • URL Normalizer section • Mime encapsulator section • Indexing section Thursday, October 28, 2010

Links PLONE CONFERENCE 2010 • collective.transmogrifier http://pypi.python.org/pypi/collective.transmogrifier/ • plone.app.transmogrifier http://pypi.python.org/pypi/plone.app.transmogrifier/ Thursday, October 28, 2010

Check out .co m/d emos s ixfeetup Thursday, October 28, 2010

Laying Pipe with Transmogrifier

by Clayton Parker

Accessibility

Categories

Upload Details

Usage Rights

1 Embed 1

Statistics