Saturday, January 14, 2012

Dexterity Development Quickstart using zopeskel.dexterity

Update:  You will probably make more progress using this: I've blogged about Plone on Dotcloud here.

These are my notes for getting started quickly with dexterity and zopeskel.dexterity.

Rule Number One: Use Unix
This is about getting started quickly. At this time, Windows will slow you down, do this on a server or something, this issue may change in the future at which point I will be able to recommend otherwise, but for now, for the sake of your sanity just use OS X or Linux for development.

Rule Number Two: Use the Unified Installer
The Unified Installer (usually available at provides all the tools you need to get started, everything here assumes that you have successfully installed Plone via the Unified Installer on your platform.

Rule Number Three: 
Install your app and run buildout BEFORE attempting to use localcommands. This is important because additional "goodness" is added to your new package when it is properly installed to your instance.

Step 1 - Install via the UnifiedInstaller then edit the base.cfg and add zopeskel.dexterity and ZopeSkel <= 2.99.

eggs =
    ZopeSkel <= 2.99

Then re-run buildout 
 Step 2 - Create your first product
cd src
../bin/zopeskel dexterity

WARNING: localcommands like "addcontent" WILL NOT WORK until you install the app and run buildout!

Step 3 - Install your app by adding it to the buildout.cfg and re-run buildout

Add the following lines to your buildout.cfg
eggs =  
develop =

or if you prefer to use mr.developer do something like this:
extensions = mr.developer
auto-checkout =
[sources] = fs
The re-run buildout

Step 4 - Add your first contenttype
Note that all localcommands are run from within your new app
cd src/
../../bin/paster addcontent dexterity_content 

You should now be able to follow the instructions at:

If you want to know what localcommands are available try running
../../bin/paster addcontent -l
Activate your new Add-on
To see if everything is working launch your instance and visit Site Setup > Add-ons, you should now be able to activate your new add-on.

In the screenshot below, I have already created a content type for my add-on, so after activation I can use the green content bar in my site to add a new example type.

1 comment:

Steve McMahon said...

Just a note on zopeskel.dexterity. Make sure you specify zopeskel<=2.99

zopeskel 3 is a development branch that is not compatible with zopeskel.dexterity.

Sign up for my upcoming Plone 5 Book & Video tutorials

plone 5 for newbies book and videos