Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

a demo recipe for oscon

Project Description
.. contents::

.. Note to recipe author!
---------------------
Update the following URLs to point to your:

- code repository
- bug tracker
- questions/comments feedback mail
(do not set a real mail, to avoid spams)

Or remove it if not used.

- Code repository: http://svn.somewhere.com/...
- Questions and comments to somemailing_list
- Report bugs at http://bug.somewhere.com/..


Detailed Documentation
**********************

Supported options
=================

The recipe supports the following options:

.. Note to recipe author!
----------------------
For each option the recipe uses you shoud include a description
about the purpose of the option, the format and semantics of the
values it accepts, whether it is mandatory or optional and what the
default value is if it is omitted.

option1
Description for ``option1``...

option2
Description for ``option2``...


Example usage
=============

.. Note to recipe author!
----------------------
zc.buildout provides a nice testing environment which makes it
relatively easy to write doctests that both demonstrate the use of
the recipe and test it.
You can find examples of recipe doctests from the PyPI, e.g.

http://pypi.python.org/pypi/zc.recipe.egg

The PyPI page for zc.buildout contains documentation about the test
environment.

http://pypi.python.org/pypi/zc.buildout#testing-support

Below is a skeleton doctest that you can start with when building
your own tests.

We'll start by creating a buildout that uses the recipe::

>>> write('buildout.cfg',
... """
... [buildout]
... parts = test1
...
... [test1]
... recipe = my.demo.recipe
... option1 = %(foo)s
... option2 = %(bar)s
... """ % { 'foo' : 'value1', 'bar' : 'value2'})

Running the buildout gives us::

>>> print 'start', system(buildout) # doctest:+ELLIPSIS
start...
Installing test1.
Unused options for test1: 'option2' 'option1'.
<BLANKLINE>



Contributors
************

${Tarek or ""}, Author


Change history
**************

${1.0 or "0.0.0"} (xxxx-xx-xx)
==================

- Created recipe with ZopeSkel [${Tarek or ""}].

Download
********
Release History

Release History

This version
History Node

1.0dev

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
my.demo.recipe-1.0dev.tar.gz (3.8 kB) Copy SHA256 Checksum SHA256 Source Jul 22, 2008

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting