Learn to use ZopeSkel and the extensibility of the underlying templer system to create skeleton templates that support your needs as a developer. Spend minutes instead of hours starting new projects so you can use your time for your customers' code.

1. Jump Start your
Development with
ZopeSkel
Cris Ewing
Cris Ewing, Developer LLC
Plone Conference 2012
Arnhem, the Netherlands

2. Overview

3. Overview
• When and Why to Use Zopeskel

4. Overview
• When and Why to Use Zopeskel
• Basics of Template Writing

5. Overview
• When and Why to Use Zopeskel
• Basics of Template Writing
• Explanation of the API

6. When

7. When
• You have code you write over and over

8. When
• You have code you write over and over
• Most of that code is identical

9. When
• You have code you write over and over
• Most of that code is identical
• What isn’t identical can be abstracted

10. Why

11. Why
• You can avoid writing all that stuff

12. Why
• You can avoid writing all that stuff
• You can set things up your way

13. Why
• You can avoid writing all that stuff
• You can set things up your way
• You can apply vc to your process

14. Writing a Template

15. What do you want?

16. mycompany_policy

17. What have you got?

18. bin/templer --list
bin/templer <template_name> --list-variables

19. max(in_common())
min(needs_doing())

20. Wire It Up

21. Create a Class

22. from templer.plone.plone import Plone
class PolicyPackage(Plone):
summary = "My skeleton for policy packages"
help = "Control the customization of a project"
_template_dir = 'policypackage'

23. Import to
Package Namespace

24. in __init__.py
from templates import PolicyPackage

25. Provide an Entry Point

26. in setup.py
...
install_requires=[
'setuptools',
# -*- Extra requirements: -*-
],
entry_points="""
# -*- Entry points: -*-
[paste.paster_create_template]
mycompany_policy = mycompany.policy:PolicyPackage
""",

27. Install
$ python setup.py develop

28. did it work?
$ bin/templer --list

29. Flesh It Out

30. Change a Var

31. In Your Class
import copy # new
from templer.core.base import get_var # new
from templer.plone.plone import Plone
class PolicyPackage(Plone):
summary = "My skeleton for policy packages"
help = "Control the customization of a project"
_template_dir = 'policypackage'
vars = copy.deepcopy(Plone.vars) # new
get_var(vars, 'add_profile').default = True # new
get_var(vars, ‘add_profile’).modes = [] # new

32. Add a Var

33. import copy
In Your Class
from templer.core.base import get_var
from templer.core.vars import EASY
from templer.core.vars import StringVar
from templer.plone.plone import Plone
class PolicyPackage(Plone):
summary = "My skeleton for policy packages"
help = "Control the customization policy of a project"
_template_dir = 'policypackage'
vars = copy.deepcopy(Plone.vars)
get_var(vars, 'add_profile').default = True
get_var(vars, 'add_profile').modes = []
vars.append(
StringVar(
'add_on_profile',
'provide the name of an add-on profile to be installed',
modes=(EASY,),
),
)

34. Add Structure

35. Your Package

36. metadata.xml_tmpl
<?xml version="1.0"?>
<metadata>
<version>001</version>
#if $add_on_profile
<dependencies>
<dependency>${add_on_profile}</dependency>
</dependencies>
#end if
</metadata>

37. Did it Work?

38. http://templer-manual.readthedocs.org/

39. API

40. Template
• Attributes
• summary
• help
• post_run_msg
• category

41. Template
• Attributes
• _template_dir
• required_templates
• default_required_structures
• use_local_commands

42. Template
• Methods
• pre
• post

43. Var
• Attributes
• name
• title
• description
• help
• category

44. Var
• Attributes
• default
• modes
• structures

45. Var
• Methods
• pretty_description
• further_help
• validate

46. Entry Point Categories
• paste.paster_create_template
• for templates you want users to run
• templer.templer_structure
• for structures users should never see
• templer.templer_sub_template
• for local commands

47. Questions?
cris@crisewing.com
cewing
@crisewing