Hi list I'm a little bit confused with the buildout configuration files, and i can't find any useful information. I get that every part of the buildout has a recipe and this recipe takes some configuration options. My question is ...how can i know which are those options? I went through the code and found most of them, but not all. For example, since i'm running on Debian i would like to use buildout + dzhandle, so i need plone.recipe.dzhandle. I found some configuration options used explicitly in the code (locationtype, location, zopetype, version, zope2-location, zopeuser, zcml, serviceuser and instancename), but i also found in an example buildout configuration file «httpport» (obvious what it is used for) and «threads» (not that obvious for me :) ). Also i would like to know which other options i can use to set, for instance, dzhandle «--addon-mode» that is mandatory when using dzhandle alone. Maybe this is very simple, i recognize that my knowledge of python is not as good as it should be...yet ;). Anyways, any hint would be useful for me. My english is not very good :(, my apologies. Thanks & happy new year! :)
A good recipe has a good documentation and/or doctests. You might check on PyPI if a recipe fulfills those requirements. Otherwise, you have to read the code or stick with a recipe with a similar functionality. -aj On 05.01.2009 20:29 Uhr, dunia wrote:
Hi list
I'm a little bit confused with the buildout configuration files, and i can't find any useful information. I get that every part of the buildout has a recipe and this recipe takes some configuration options. My question is ...how can i know which are those options? I went through the code and found most of them, but not all.
For example, since i'm running on Debian i would like to use buildout + dzhandle, so i need plone.recipe.dzhandle. I found some configuration options used explicitly in the code (locationtype, location, zopetype, version, zope2-location, zopeuser, zcml, serviceuser and instancename), but i also found in an example buildout configuration file «httpport» (obvious what it is used for) and «threads» (not that obvious for me :) ). Also i would like to know which other options i can use to set, for instance, dzhandle «--addon-mode» that is mandatory when using dzhandle alone.
Maybe this is very simple, i recognize that my knowledge of python is not as good as it should be...yet ;). Anyways, any hint would be useful for me.
My english is not very good :(, my apologies.
Thanks & happy new year! :) _______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org http://mail.python.org/mailman/listinfo/distutils-sig
-- ZOPYX Ltd. & Co. KG - Charlottenstr. 37/1 - 72070 Tübingen - Germany Web: www.zopyx.com - Email: info@zopyx.com - Phone +49 - 7071 - 793376 Registergericht: Amtsgericht Stuttgart, Handelsregister A 381535 Geschäftsführer/Gesellschafter: ZOPYX Limited, Birmingham, UK ------------------------------------------------------------------------ E-Publishing, Python, Zope & Plone development, Consulting
On Jan 5, 2009, at 2:29 PM, dunia wrote:
Hi list
I'm a little bit confused with the buildout configuration files, and i can't find any useful information. I get that every part of the buildout has a recipe and this recipe takes some configuration options. My question is ...how can i know which are those options? I went through the code and found most of them, but not all.
Do you mean, "How do you know which options are available?" I'll assume yes.
Maybe this is very simple, i recognize that my knowledge of python is not as good as it should be...yet ;). Anyways, any hint would be useful for me.
You have to rely on the recipe documentation. Recipes should provide documentation that describes how they're used, including what their options are. Many recipes make this available as part of their PYPI pages (For example, see http://pypi.python.org/pypi/zc.recipe.deployment) . Buildout doesn't provide an API for a recipe to register or declare the options it provides. Perhaps it should. My philosophy has been to try make as few demands on recipe authors as possible. I could see some benefit in providing an optional registration mechanism that buildout could use if it's present. Jim -- Jim Fulton Zope Corporation
On Tue, Jan 6, 2009 at 1:37 PM, Jim Fulton <jim@zope.com> wrote:
On Jan 5, 2009, at 2:29 PM, dunia wrote:
Hi list
I'm a little bit confused with the buildout configuration files, and i can't find any useful information. I get that every part of the buildout has a recipe and this recipe takes some configuration options. My question is ...how can i know which are those options? I went through the code and found most of them, but not all.
Do you mean, "How do you know which options are available?"
I'll assume yes.
Maybe this is very simple, i recognize that my knowledge of python is not as good as it should be...yet ;). Anyways, any hint would be useful for me.
You have to rely on the recipe documentation. Recipes should provide documentation that describes how they're used, including what their options are. Many recipes make this available as part of their PYPI pages (For example, see http://pypi.python.org/pypi/zc.recipe.deployment). Buildout doesn't provide an API for a recipe to register or declare the options it provides. Perhaps it should.
+1
My philosophy has been to try make as few demands on recipe authors as possible.
As a buildout newbie , I would recommend offering the recipe author a standard way to briefly describe available options. Thanks, Kent
I could see some benefit in providing an optional registration mechanism that buildout could use if it's present.
Jim
-- Jim Fulton Zope Corporation
_______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org http://mail.python.org/mailman/listinfo/distutils-sig
On Thu, Jan 15, 2009 at 5:00 AM, Kent Tenney <ktenney@gmail.com> wrote:
My philosophy has been to try make as few demands on recipe authors as possible.
As a buildout newbie , I would recommend offering the recipe author a standard way to briefly describe available options.
ZopeSkel provides a template that creates your recipe layout with a nice documentation ala Jim, with comments on how you have to complete it. It's massively used in the Plone community, and the recipe doc all look the same Tarek
On Mon, Jan 5, 2009 at 8:37 PM, Jim Fulton <jim@zope.com> wrote:
You have to rely on the recipe documentation. Recipes should provide documentation that describes how they're used, including what their options are. Many recipes make this available as part of their PYPI pages (For example, see http://pypi.python.org/pypi/zc.recipe.deployment). Buildout doesn't provide an API for a recipe to register or declare the options it provides. Perhaps it should.
We did work on that in a sprint with Godefroid, to be able to display recipe options doc from the command line at the Snow sprint. But I can't see the branch anymore.. Tarek -- Tarek Ziadé | Association AfPy | www.afpy.org Blog FR | http://programmation-python.org Blog EN | http://tarekziade.wordpress.com/
Tarek Ziadé wrote:
On Mon, Jan 5, 2009 at 8:37 PM, Jim Fulton <jim@zope.com> wrote:
You have to rely on the recipe documentation. Recipes should provide documentation that describes how they're used, including what their options are. Many recipes make this available as part of their PYPI pages (For example, see http://pypi.python.org/pypi/zc.recipe.deployment). Buildout doesn't provide an API for a recipe to register or declare the options it provides. Perhaps it should.
We did work on that in a sprint with Godefroid, to be able to display recipe options doc from the command line at the Snow sprint.
But I can't see the branch anymore..
Tarek
The branch was zc.buildout/branches/help-api. -- Godefroid Chapelle (aka __gotcha) http://bubblenet.be
participants (6)
-
Andreas Jung -
dunia -
Godefroid Chapelle -
Jim Fulton -
Kent Tenney -
Tarek Ziadé