[Checkins] SVN: buildout-website/trunk/source/docs/recipe.rst Split to sections
Baiju M
baiju.m.mail at gmail.com
Thu Apr 23 17:39:08 EDT 2009
Log message for revision 99436:
Split to sections
Changed:
U buildout-website/trunk/source/docs/recipe.rst
-=-
Modified: buildout-website/trunk/source/docs/recipe.rst
===================================================================
--- buildout-website/trunk/source/docs/recipe.rst 2009-04-23 18:22:43 UTC (rev 99435)
+++ buildout-website/trunk/source/docs/recipe.rst 2009-04-23 21:39:08 UTC (rev 99436)
@@ -1,6 +1,10 @@
-Creating Recipes
-================
+Developing Buildout Recipes
+===========================
+
+Introduction
+------------
+
A Buildout part is created by a recipe. Recipes are always installed
as Python eggs. They can be downloaded from a package server, such as
the Python Package Index, or they can be developed as part of a
@@ -12,6 +16,10 @@
modified in place, which is especially useful while they are being
developed.
+
+Initial steps
+-------------
+
Let's create a recipe as part of the sample project. We'll create a
recipe for creating directories. First, we'll create a recipes source
directory for our local recipes::
@@ -130,6 +138,9 @@
be exposed as entry points in the zc.buildout group. we give entry
points names within the group.
+Using recipes
+-------------
+
We also need a README.txt for our recipes to avoid an annoying warning
from distutils, on which setuptools and zc.buildout are based::
@@ -260,3 +271,19 @@
Uninstalling data-dir.
Installing data-dir.
data-dir: Creating directory mydata
+
+
+Publishing recipe to PyPI
+-------------------------
+
+
+Conclusion
+----------
+
+Recipe is the extension mechanism provided by Buildout. There are
+hundreds of `recipes available in PyPI
+<http://pypi.python.org/pypi?:action=browse&show=all&c=512>`_ and
+some important ones are listed in the `recipe list
+<recipelist.html>`_ . If you need any functionality for building
+your application check the list of recipes available, otherwise you
+can create one yourself.
More information about the Checkins
mailing list