ZopeSkel

ZopeSkel is a Python module that provides a collection of skeletons for quickstarting Zope and Plone projects.

All skeletons are available as PasteScript templates and can be used via the ''paster'' commandline tool. For example to create a package for a Plone 3 theme you can do:

paster create -t plone3_theme

this will ask a few questions such as desired package name and a description and output a complete package skeleton that you can immediately start using.

Please contribute by submitting patches for what you consider 'best of breed' file layouts for starting Zope projects.

What is new in this release:

• Depend on templer packages, remove all local templates, update README [cewing]

What is new in version 2.21.2:

• Fixing bad bad release fixer [cewing]

What is new in version 2.20:

• Remove buildout.threatlevel extension from plone4_buildout. [davisagli]
• Made plone4_buildout simpler: now it only asks for Plone version [miohtama]
• Various references to Internet documentation [miohtama]
• Created a recommended path how ZopeSkel templates should be used to create a new Plone site project [miohtama]
• Bumped Plone 4 version to 4.0.5 [miohtama]
• Edit plone3_buildout help text, fixes: http://plone.org/products/zopeskel/issues/59 [aclark]

What is new in version 2.19:

• In every setup.py, replace ':' with ':', making list_classifier url an url which can actually be used. [thet]
• Added plone4_buildout [miohtama]
• Improvements to README [miohtama]

What is new in version 2.18:

• Add bin/zopeskel --version flag. Reports current version of zopeskel (http://plone.org/products/zopeskel/issues/48) [cewing]
• plone3_buildout: use Plone 3.3.5 by default. [maurits]
• Fixed a problem with the generic setup profile in plone templates in which a profile was registered in zcml, but no profiles directory was created. (http://plone.org/products/zopeskel/issues/46) [cewing]
• use i18n:domain plone for portlet title so it need not be translated twice (http://plone.org/products/zopeskel/issues/44) [fRiSi]
• use the correct name of package, so it can be used in package with 2 dots or 1 dots in package name [lucmult]

What is new in version 2.17:

• Added a pin for PasteScript>=1.7.2. This solves an issue where using zopeskel with an early version of PasteScript resulted in a method signature mismatch on the paster command 'challenge' method. Fixes issue #42 (http://plone.org/products/zopeskel/issues/42) [cewing]
• Fixed lingering problem in Archetypes template with registering a 'locales' directory before one is created. Users now need to add an i18nlocale via addcontent in order to get this directory and have it registered via zcml. [cewing]
• Fixed dependency in Archetypes template doctests on the presence of the log-in portlet. Tests now open the 'login_form' instead. Resolves issue #40 (http://plone.org/products/zopeskel/issues/40) [cewing]
• Added new browserlayer localcommand for plone and archetype templates. [marcosfromero]
• Added stub locales directory for plone3_theme template, resolving issue #33 (http://plone.org/products/zopeskel/issues/33) [cewing]
• Set the GenericSetup profile version number in the generated metadata.xml to 1000, which is better for the alphabetical ordering that GS does. [maurits]
• Added "environment-vars = zope_i18n_compile_mo_files = true" to plone3_buildout template. This is enabled only for Plone 4 (eggifiedzope is true). [vincentfretin]

What is new in version 2.16:

• Fixed syntax error in generated portlet constructor code [ajung]
• Added a new 'BoundedIntVar' variable type. It validates that the provided argument is both an integer and between provided min and max values (inclusive on both ends). [cewing]
• Updated archetype and plone3_portlet templates to comply with pep8 and pyflakes validation at all stages of a skeleton build process. Resolves the issue here: (http://plone.org/products/zopeskel/issues/24) [cewing]
• Added explanatory text to the plone_hosting template regarding the fact that it is unsuitable for use with plone versions later than 3.1.7, fixed http://plone.org/products/zopeskel/issues/25 [cewing]
• Fixed the problem with generated archetypes content type meta_type names documented here: (http://plone.org/products/zopeskel/issues/22) [cewing]
• Updated tests for the plone template to include tests for the fixes to message factory, zcml sub-package include and i18n translation registration problems below [cewing]
• Cleaned up a number of issues with defining and importing a package-wide MessageFactory in plone template local commands: (http://plone.org/products/zopeskel/issues/29) [cewing]
• Cleaned up a number of issues with importing sub-package zcml files after using local commands in the plone template: (http://plone.org/products/zopeskel/issues/28) [cewing]
• Fixed an issue with the plone template zcmlmeta local command to ensure that the proper directive was inserted into the top-level configure.zcml [cewing]
• Fixed the bug in the plone template that caused zcml errors when the i18nlocale local command had not been run: (http://plone.org/products/zopeskel/issues/26) [cewing]
• Improved i18n for portlets (http://plone.org/products/zopeskel/issues/31) [fRiSi]
• Improved test coverage of the zopeskel script [cewing]
• Disallowed use of the paster --svn-repository command due to some basic incompatibilities with the way zopeskel is used. The argument is still allowed for users via 'paster create'. (http://plone.org/products/zopeskel/issues/34 http://plone.org/products/zopeskel/issues/35) [cewing]
• Added a 'Register Profile' question to the plone template so that users can have a Generic Setup profile registered in the case that they plan on adding things (like portlets) that require a GS Profile to install. Adapted downstream templates archetype, plone25_theme and plone3_theme to use the new question [cewing]

What is new in version 2.15:

• Backed out a few changes from jaroel in favor of retaining working templates OOTB [cewing]
• Made archetype, plone3_theme and plone3_portlet pass the PEP8 validator and pyflakes. [jaroel]
• Template summaries (one-line descriptions) were improved. [pupq]
• Templates now have an optional help attribute, which is a rich description of the template and its purpose. Help has been provided for all the ZopeSkel templates. [pupq/cewing]
• Variables (questions in templates) now have a human-facing "title" attribute which can be shown instead of the (uglier + more opaque) actual variable name. Titles have been written for questions. [pupq]
• Variables now have optional help attribute, which is a rich description of the variable. This can be shown in pastescript UIs. [pupq]
• Interactive help has been added, so that you can enter "?" at any question to receive the rich help for that question. [cewing]
• "Modes" have been implemented--easy, expert, and all--to reduce the number of questions posed to beginning users. For example, technical questions (like "namespace package 2") are now shown only in expert mode. [cewing/pupq]
• The project name (eg, "plone.app.example") is now split into pieces to become the default values for namespace packages names ("plone", "app", "example"). [pupq]
• Templates can provide an ndot attribute that signals how many namespaces ("dots") are expected in the project name. When invoked through new zopeskel front-end script, names that don't support that pattern are rejected with help (eg, creating a plone_app with "plone.example" would be rejected, as a 2-namespaced-name, "plone.foo.example", is expected) [pupq]
• Rather than having to use the checkvar() and post() methods, templates can now support messages that appear pre-questions and post-generation. Appropriate warnings and where-to-go help has been added. [cewing]
• Abstract classes for zope2 products and buildouts have been added; this simplifies inheritance of common attrs, and provides appropriate places for future common logic. [pupq]
• A front-end script, 'zopeskel', has been added. This has high-level, friendly help, and an improved command line interface for the task of template usage. It can provide a friendly list of templates and a verbosely-detailed list of templates. [pupq/cewing/chrisrossi]
• Users can have a "$HOME/.zopeskel" script with default values for questions, either on a all-template or template-by-template basis. [pupq]
• The "zopeskel" script can emit a sample ".zopeskel" file, for editing. [pupq/cbc]
• A simple HTML help generator can produce a listing of templates, fields, and subtemplates. This will be useful for maintaining an HTML "reference guide" to the ZopeSkel templates. Find this in the zopeskel.doctools package. [pupq/cbc]
• Currently-failing unit tests were fixed. [pupq/cewing]
• New unit tests were written for new features. [cewing]
• New and repaired unit tests were added into the default test suite [cewing]
• Rather than using a generic var() class for all variables ("questions"), subclasses for different types of variables--string, boolean, choices, etc.--were added. These normalize their own values and provide validation. Therefore, users will get earlier/better feedback on inappropriate values. [pupq/cewing]
• A proposal for splitting the project into zopeskel.* packages was added. [pupq/cbc]
• Where questions were duplicated across different templates, they were consolidated for consistency into one place, and referred to from other places. [pupq]
• A real-time tool for generating graphs of dependencies and template inheritance was written, suitable for including in high-level documentation. Find this in the zopeskel.doctools package. [cbc]
• Use the eggified Zope 2.12.3 for buildouts targeting Plone 4.x. Use 2.9.12 for buildouts targeting Plone 2.x. [maurits]
• Remove unnecessary 'title' argument from jsregistry.xml example. This fixes http://plone.org/products/zopeskel/issues/18. [dukebody]

What is new in version 2.14.2:

• Back out untested, undocumented changes from paris sprint that broke some templates [MatthewWilkes]

Requirements:

• Python