************
ZODB Recipes
************
Recipes for working with ZODB.
.. contents::
Changes
*******
3.1 (2024-10-10)
================
- Add support for Python 3.12, 3.13.
- Drop support for Python 3.7.
- Modify read/write operations to use Path() to avoid dangling file handles.
3.0 (2023-02-07)
================
- Add support for Python 3.7, 3.8, 3.9, 3.10, 3.11.
- Drop support for Python < 3.7.
2.0.0 (2014-02-12)
==================
This release isn't backward compatible
It uses ZODB, rather than ZODB3.
- Added Python 3 support
- Changed from ZODB3 to ZODB.
0.6.2 (2012-10-31)
==================
Bugs Fixed
----------
- Moved 'zope.testing' requirement from install to test requirement.
0.6.1 (2010-05-25)
==================
Bugs Fixed
----------
- Pack scripts were incorrectly generated for storages that weren't
named in their storage configurations.
0.6.0 (2009-12-03)
==================
New Features
------------
- Generation of a logrotate configuration can now be disabled by
providing a logrotate option with a value of "false".
- Added documentation of the eggs option and why it generally
shouldn't be used.
- Improved error handling.
Bugs Fixed
----------
- The eggs option, when used, wasn't handled properly.
0.5.0 (2008-11-03)
==================
New Features
------------
You can now specify a name option in server parts to have installed
files use a different name than the section name.
Bugs Fixed
----------
Pack crontab files weren't removed when parts were removed or renamed.
0.4 (2008-02-18)
================
New Features
------------
The server recipe now honors the deployment name option.
0.3.1 (2008-01-03)
==================
Bugs Fixed
----------
Shell-scripts using su weren't generated correctly.
0.3 (2008-01-03)
================
New Features
------------
- You can now specify an email address in a packing crontab file to
control where errors are sent.
- If you install a general ZEO script, using a zdaemon part::
[zdaemon]
recipe = zc.recipe.egg:script
eggs = zdaemon
you can request that shell scripts be generated that use the generic
zdaemon script. This can make updating software for deployed systems
easier since instance-specific scripts don't depend on paths, like
egg names, that are likely to change.
Bugs Fixed
----------
- ZODB3 and most of its requirements were spurious dependencies of the
recipes. This caused ZODB3 to be installed using the Python used to
run the buildout, which caused problems in some circumstances.
0.2.1 (2007-04-23)
==================
Bugs Fixed
----------
- crontab and logrotate configuration files were being generates incorrectly.
0.2 (2007-04-17)
================
Added handling of %import directives.
0.1 (2007-04-13)
================
Initial release.
Detailed Documentation
**********************
Defining ZEO Storage Servers
============================
The zc.zodbrecipes:server recipe can be used to define ZEO storage
servers. To define a storage server, you define a part for the server
and specify configuration data.
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = server
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %import foo
... <foo>
... path /databases/Data.fs
... </foo>
... ''')
Here we specified a minimal configuration using a "foo" storage. We
can use any kind of storage we want. Here we used an import statement
to import the schema definition that defined the foo section. Any
imports are simply copied to the generated configuration file. When
we run the buildout:
>>> print(system(buildout), end='') # doctest: +NORMALIZE_WHITESPACE
Installing server.
zc.zodbrecipes:
A runzeo script couldn't be found at:
<BLANKLINE>
'/sample-buildout/bin/runzeo'
<BLANKLINE>
You may need to generate a runzeo script using the
zc.recipe.eggs:script recipe and the ZEO egg, or you may need
to specify the location of a script using the runzeo option.
<BLANKLINE>
Generated script '/sample-buildout/bin/server'.
We got a warning because the recipe expects there to be a runzeo
script and we haven't created one. This is done using the
zc.recipe.egg:script recipe:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %import foo
... <foo>
... path /databases/Data.fs
... </foo>
... ''')
>>> print(system(buildout), end='') # doctest: +ELLIPSIS
Installing zodb...
Generated script '/sample-buildout/bin/runzeo'...
Updating server.
We get 2 things. We get a directory in parts containing ZEO and
zdaemon configuration files:
>>> ls('parts', 'server')
- zdaemon.conf
- zeo.conf
Let's look at the configuration files:
>>> cat('parts', 'server', 'zeo.conf')
%import foo
<BLANKLINE>
<zeo>
address 8100
monitor-address 8101
transaction-timeout 300
</zeo>
<BLANKLINE>
<foo>
path /databases/Data.fs
</foo>
<BLANKLINE>
<eventlog>
<logfile>
path STDOUT
</logfile>
</eventlog>
We see the same data we input with the addition of an eventlog section
that directs logging to standard out. In production, we'll use
zdaemon's transacript log to capture this logging output in a file.
If we wish, we can specify a log file ourselves:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %import foo
... <foo>
... path /databases/Data.fs
... </foo>
... <eventlog>
... <logfile>
... path /var/log/zeo.log
... </logfile>
... </eventlog>
... ''')
>>> print(system(buildout), end='')
Uninstalling server.
Updating zodb.
Installing server.
Generated script '/sample-buildout/bin/server'.
>>> cat('parts', 'server', 'zeo.conf')
%import foo
<BLANKLINE>
<zeo>
address 8100
monitor-address 8101
transaction-timeout 300
</zeo>
<BLANKLINE>
<foo>
path /databases/Data.fs
</foo>
<BLANKLINE>
<eventlog>
<logfile>
path /var/log/zeo.log
</logfile>
</eventlog>
But we'll stick with the default:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %import foo
... <foo>
... path /databases/Data.fs
... </foo>
... ''')
>>> print(system(buildout), end='')
Uninstalling server.
Updating zodb.
Installing server.
Generated script '/sample-buildout/bin/server'.
Let's look at the zdaemon log file:
>>> cat('parts', 'server', 'zdaemon.conf')
<runner>
daemon on
directory /sample-buildout/parts/server
program /sample-buildout/bin/runzeo -C /sample-buildout/parts/server/zeo.conf
socket-name /sample-buildout/parts/server/zdaemon.sock
transcript /sample-buildout/parts/server/zeo.log
</runner>
<BLANKLINE>
<eventlog>
<logfile>
path /sample-buildout/parts/server/zeo.log
</logfile>
</eventlog>
We run the runzeo script with the zeo.conf file. Log and run-time
files are places in the server part directory. We use a transcript
log to provide the ZEO server log. I like to use the transacriot log
because it captures program output, such as start-up exceptions that
aren't captured in a program's logs.
And we get a control script generated in our bin directory:
>>> cat('bin', 'server') # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS
#!/usr/local/bin/python2.4
<BLANKLINE>
import sys
sys.path[0:0] = [...]
<BLANKLINE>
<BLANKLINE>
import zdaemon.zdctl
<BLANKLINE>
if __name__ == '__main__':
sys.exit(zdaemon.zdctl.main([
'-C', '/sample-buildout/parts/server/zdaemon.conf',
]+sys.argv[1:]
))
This is a zdaemon script. We can use this to control the ZEO server
process.
Specifying additional eggs
==========================
You can specify additional eggs to be installed for use by the
zdaemon script:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... eggs = zope.event
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %import foo
... <foo>
... path /databases/Data.fs
... </foo>
... ''')
>>> print(system(buildout), end='')
Uninstalling server.
Updating zodb.
Installing server.
Generated script '/sample-buildout/bin/server'.
We can see the zope.event egg present in the control script
generated in our bin directory:
>>> cat('bin', 'server') # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS
#!/usr/local/bin/python2.4
<BLANKLINE>
import sys
sys.path[0:0] = [...]
<BLANKLINE>
import zdaemon.zdctl
<BLANKLINE>
if __name__ == '__main__':
sys.exit(zdaemon.zdctl.main([
'-C', '/sample-buildout/parts/server/zdaemon.conf',
]+sys.argv[1:]
))
NB: This is a zdaemon script. If your ZEO server needs additional eggs, such as
to provide additional storage types or log handlers, they should appear in
[zodb] section in the above example, NOT the [server] section!
Unix Deployment support
=======================
The server recipe works with the zc.recipe.deployment. In particular,
if a deployment option is specified, it names a part or section that
defines the following uptions:
crontab-directory
A directory for crontab files.
etc-directory
A directory for configuration files.
log-directory
A directory for log files.
logrotate-directory
A directory for logrotate configuration files.
rc-directory
A directory for run-control scripts.
run-directory
A directory for run-time files.
user
The user the server process should run as
Let's create some directories and add a deployment section to our
buildout:
>>> for d in 'cron', 'etc', 'log', 'rotate', 'rc', 'run':
... mkdir(d)
... globals()[d] = join(sample_buildout, d)
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %%import foo
... <foo>
... path /databases/Data.fs
... </foo>
... deployment = demo
...
... [demo]
... crontab-directory = %(cron)s
... etc-directory = %(etc)s
... log-directory = %(log)s
... logrotate-directory = %(rotate)s
... rc-directory = %(rc)s
... run-directory = %(run)s
... user = bob
... ''' % globals())
>>> print(system(buildout), end='')
Uninstalling server.
Updating zodb.
Installing server.
Generated script '/sample-buildout/rc/demo-server'.
Now, the parts directory and the control script will be gone:
>>> import os
>>> os.path.exists(join('parts', 'server'))
False
>>> os.path.exists(join('bin', 'server'))
False
Instead, the control script will be in the rc directory:
>>> cat('rc', 'demo-server') # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS
#!/usr/local/bin/python2.4
<BLANKLINE>
import sys
sys.path[0:0] = [...]
<BLANKLINE>
import zdaemon.zdctl
<BLANKLINE>
if __name__ == '__main__':
sys.exit(zdaemon.zdctl.main([
'-C', '/sample-buildout/etc/server-zdaemon.conf',
]+sys.argv[1:]
))
The run-control script name now combines the deployment name and the
script name.
and the configuration files will be in the etc directory:
>>> ls('etc')
- server-zdaemon.conf
- server-zeo.conf
Log rotation
============
If a deployment is used, we'll also get a logrotate configuration file:
>>> cat('rotate', 'demo-server')
/sample-buildout/log/server-zeo.log {
rotate 5
weekly
postrotate
/sample-buildout/rc/demo-server -C /sample-buildout/etc/server-zdaemon.conf reopen_transcript
endscript
}
This will rotate the zeo log file once a week.
If we look at the zdaemon configuration file, we can see that it reflects
the deployment locations:
>>> cat('etc', 'server-zdaemon.conf')
<runner>
daemon on
directory /sample-buildout/run
program /sample-buildout/bin/runzeo -C /sample-buildout/etc/server-zeo.conf
socket-name /sample-buildout/run/server-zdaemon.sock
transcript /sample-buildout/log/server-zeo.log
user bob
</runner>
<BLANKLINE>
<eventlog>
<logfile>
path /sample-buildout/log/server-zeo.log
</logfile>
</eventlog>
Note that different file names are used. Since a deployment may be
(and usually is) shared by multiple parts, files are prefixed with
their part names. Also note that the deployment user is set in the
zdaemon configuration.
If you want to manage your own log rotation, you can place "logrotate = false"
in your deployment section to prevent the logrotate config being generated:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %%import foo
... <foo>
... path /databases/Data.fs
... </foo>
... deployment = demo
...
... [demo]
... logrotate = false
... crontab-directory = %(cron)s
... etc-directory = %(etc)s
... log-directory = %(log)s
... logrotate-directory = %(rotate)s
... rc-directory = %(rc)s
... run-directory = %(run)s
... user = bob
... ''' % globals())
>>> print(system(buildout), end='')
Uninstalling server.
Updating zodb.
Installing server.
Generated script '/sample-buildout/rc/demo-server'.
The logrotate config is not there, but the rc script still is:
>>> ls('rotate')
>>> ls('rc')
- demo-server
If it's more convenient, this can be placed in the [server] section instead:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %%import foo
... <foo>
... path /databases/Data.fs
... </foo>
... deployment = demo
... logrotate = false
...
... [demo]
... crontab-directory = %(cron)s
... etc-directory = %(etc)s
... log-directory = %(log)s
... logrotate-directory = %(rotate)s
... rc-directory = %(rc)s
... run-directory = %(run)s
... user = bob
... ''' % globals())
>>> print(system(buildout), end='')
Updating zodb.
Updating server.
The logrotate config is not there, but the rc script still is:
>>> ls('rotate')
>>> ls('rc')
- demo-server
Packing cron job
================
We can request definition of a cron job to pack the databases by
specifying a pack option. This option takes 5 to 7 values. The
first 5 values are the time and date fields defined by Unix crontab
files. The sixth field is the number of days in the past to pack to and
defaults to 1.
Let's add a pack option:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %%import foo
... <foo>
... path /databases/Data.fs
... </foo>
... deployment = demo
... pack = 1 1 * * 0 3
...
... [demo]
... crontab-directory = %(cron)s
... etc-directory = %(etc)s
... log-directory = %(log)s
... logrotate-directory = %(rotate)s
... rc-directory = %(rc)s
... run-directory = %(run)s
... user = bob
... ''' % globals())
>>> print(system(buildout+' -D'), end='')
Uninstalling server.
Updating zodb.
Installing server.
Generated script '/sample-buildout/rc/demo-server'.
Now, we'll get a crontab file:
>>> cat(cron, 'pack-demo-server')
1 1 * * 0 bob /sample-buildout/bin/zeopack -p 8100 -S 1 -d 3
.. Make sure it works to supply a storage name:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %%import foo
... <foo x>
... path /databases/Data.fs
... </foo>
... deployment = demo
... pack = 1 1 * * 0 3
...
... [demo]
... crontab-directory = %(cron)s
... etc-directory = %(etc)s
... log-directory = %(log)s
... logrotate-directory = %(rotate)s
... rc-directory = %(rc)s
... run-directory = %(run)s
... user = bob
... ''' % globals())
>>> _ = system(buildout+' -D'),
>>> cat(cron, 'pack-demo-server')
1 1 * * 0 bob /sample-buildout/bin/zeopack -p 8100 -S x -d 3
In this example, we'll pack the databases every Sunday at 1:01 to 3
days.
We can add an email address to the pack option. If we do, then a
MAILTO variable will be added to the cron file:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %%import foo
... <foo>
... path /databases/Data.fs
... </foo>
... deployment = demo
... pack = 1 1 * * 0 3 jim@zope.com
...
... [demo]
... crontab-directory = %(cron)s
... etc-directory = %(etc)s
... log-directory = %(log)s
... logrotate-directory = %(rotate)s
... rc-directory = %(rc)s
... run-directory = %(run)s
... user = bob
... ''' % globals())
>>> print(system(buildout+' -D'), end='')
Uninstalling server.
Updating zodb.
Installing server.
Generated script '/sample-buildout/rc/demo-server'.
>>> cat(cron, 'pack-demo-server')
MAILTO=jim@zope.com
1 1 * * 0 bob /sample-buildout/bin/zeopack -p 8100 -S 1 -d 3
This causes email to be sent to the given address, rather than to the
user specified in the crontab file.
shell start scripts
===================
By default, the startup scripts are generated Python scripts that use
the zdaemon module. Sometimes, this is inconvenient. In particular,
when deploying software, generated Python scripts may break after a
software update because they contain pasths to software eggs. We can
request shell scripts that invoke a generic zdaemon script. The shell
script only depends on the path to the zdaemon script, which generally
doesn't change when updating softawre.
To request a shell script, add a shell-script option with a true
value. We also need to cause a zdaemon script to be generated:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb zdaemon server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [zdaemon]
... recipe = zc.recipe.egg:script
... eggs = zdaemon
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %%import foo
... <foo>
... path /databases/Data.fs
... </foo>
... deployment = demo
... pack = 1 1 * * 0 3 jim@zope.com
... shell-script = true
...
... [demo]
... crontab-directory = %(cron)s
... etc-directory = %(etc)s
... log-directory = %(log)s
... logrotate-directory = %(rotate)s
... rc-directory = %(rc)s
... run-directory = %(run)s
... user = bob
... ''' % globals())
>>> print(system(buildout+' -D'), end='')
Uninstalling server.
Updating zodb.
Installing zdaemon.
Generated script '/sample-buildout/bin/zdaemon'.
Installing server.
zc.zodbrecipes: Generated shell script '/sample-buildout/rc/demo-server'.
>>> cat('rc', 'demo-server')
#!/bin/sh
su bob -c \
"/sample-buildout/bin/zdaemon -C '/sample-buildout/etc/server-zdaemon.conf' $*"
Names
=====
Names can be specified for deployments and for individual server
parts. These names determine names of files generated.
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb zdaemon server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [zdaemon]
... recipe = zc.recipe.egg:script
... eggs = zdaemon
...
... [server]
... name = Server
... recipe = zc.zodbrecipes:server
... zeo.conf =
... <zeo>
... address 8100
... monitor-address 8101
... transaction-timeout 300
... </zeo>
... %%import foo
... <foo>
... path /databases/Data.fs
... </foo>
... deployment = demo
... pack = 1 1 * * 0 3 jim@zope.com
... shell-script = true
...
... [demo]
... name = Demo
... crontab-directory = %(cron)s
... etc-directory = %(etc)s
... log-directory = %(log)s
... logrotate-directory = %(rotate)s
... rc-directory = %(rc)s
... run-directory = %(run)s
... user = bob
... ''' % globals())
>>> print(system(buildout+' -D'), end='')
Uninstalling server.
Updating zodb.
Updating zdaemon.
Installing server.
zc.zodbrecipes: Generated shell script '/sample-buildout/rc/Demo-Server'.
>>> ls(cron)
- pack-Demo-Server
>>> ls(etc)
- Server-zdaemon.conf
- Server-zeo.conf
>>> ls(rotate)
- Demo-Server
>>> ls(rc)
- Demo-Server
Feedback when you make mistakes
===============================
If you make a mistake in your zeo.conf, some errors will result in a
simple, informative message being returned:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf =
... nothing useful
... ''')
>>> print(system(buildout+' -q'), end='')
Couldn't clean up '/sample-buildout/bin/server'.
While:
Installing server.
Error: No zeo section was defined.
If your zeo.conf has a syntax error, you'll get shown the problematic
text and the message from the error:
>>> write('buildout.cfg',
... '''
... [buildout]
... parts = zodb server
...
... [zodb]
... recipe = zc.recipe.egg:script
... eggs = ZEO
...
... [server]
... recipe = zc.zodbrecipes:server
... zeo.conf = <bad
... ''')
>>> print(system(buildout+' -q'), end='')
Couldn't clean up '/sample-buildout/bin/server'.
While:
Installing server.
Error: malformed section start (line 1) in:
<bad
<BLANKLINE>
Download
**********************
Raw data
{
"_id": null,
"home_page": "https://github.com/zopefoundation/zc.zodbrecipes",
"name": "zc.zodbrecipes",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "zodb buildout",
"author": "Jim Fulton",
"author_email": "jim@zope.com",
"download_url": "https://files.pythonhosted.org/packages/63/24/704724a7169afb3dedd328791c970552d34897819f6c03eba2c6ed5eb06c/zc.zodbrecipes-3.1.tar.gz",
"platform": null,
"description": "************\nZODB Recipes\n************\n\nRecipes for working with ZODB.\n\n.. contents::\n\nChanges\n*******\n\n3.1 (2024-10-10)\n================\n\n- Add support for Python 3.12, 3.13.\n\n- Drop support for Python 3.7.\n\n- Modify read/write operations to use Path() to avoid dangling file handles.\n\n\n3.0 (2023-02-07)\n================\n\n- Add support for Python 3.7, 3.8, 3.9, 3.10, 3.11.\n\n- Drop support for Python < 3.7.\n\n\n2.0.0 (2014-02-12)\n==================\n\nThis release isn't backward compatible\n It uses ZODB, rather than ZODB3.\n\n- Added Python 3 support\n\n- Changed from ZODB3 to ZODB.\n\n0.6.2 (2012-10-31)\n==================\n\nBugs Fixed\n----------\n\n- Moved 'zope.testing' requirement from install to test requirement.\n\n0.6.1 (2010-05-25)\n==================\n\nBugs Fixed\n----------\n\n- Pack scripts were incorrectly generated for storages that weren't\n named in their storage configurations.\n\n0.6.0 (2009-12-03)\n==================\n\nNew Features\n------------\n\n- Generation of a logrotate configuration can now be disabled by\n providing a logrotate option with a value of \"false\".\n\n- Added documentation of the eggs option and why it generally\n shouldn't be used.\n\n- Improved error handling.\n\nBugs Fixed\n----------\n\n- The eggs option, when used, wasn't handled properly.\n\n\n0.5.0 (2008-11-03)\n==================\n\nNew Features\n------------\n\nYou can now specify a name option in server parts to have installed\nfiles use a different name than the section name.\n\nBugs Fixed\n----------\n\nPack crontab files weren't removed when parts were removed or renamed.\n\n0.4 (2008-02-18)\n================\n\nNew Features\n------------\n\nThe server recipe now honors the deployment name option.\n\n0.3.1 (2008-01-03)\n==================\n\nBugs Fixed\n----------\n\nShell-scripts using su weren't generated correctly.\n\n0.3 (2008-01-03)\n================\n\nNew Features\n------------\n\n- You can now specify an email address in a packing crontab file to\n control where errors are sent.\n\n- If you install a general ZEO script, using a zdaemon part::\n\n [zdaemon]\n recipe = zc.recipe.egg:script\n eggs = zdaemon\n\n you can request that shell scripts be generated that use the generic\n zdaemon script. This can make updating software for deployed systems\n easier since instance-specific scripts don't depend on paths, like\n egg names, that are likely to change.\n\nBugs Fixed\n----------\n\n- ZODB3 and most of its requirements were spurious dependencies of the\n recipes. This caused ZODB3 to be installed using the Python used to\n run the buildout, which caused problems in some circumstances.\n\n0.2.1 (2007-04-23)\n==================\n\nBugs Fixed\n----------\n\n- crontab and logrotate configuration files were being generates incorrectly.\n\n0.2 (2007-04-17)\n================\n\nAdded handling of %import directives.\n\n0.1 (2007-04-13)\n================\n\nInitial release.\n\nDetailed Documentation\n**********************\n\nDefining ZEO Storage Servers\n============================\n\nThe zc.zodbrecipes:server recipe can be used to define ZEO storage\nservers. To define a storage server, you define a part for the server\nand specify configuration data.\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = server\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... ''')\n\nHere we specified a minimal configuration using a \"foo\" storage. We\ncan use any kind of storage we want. Here we used an import statement\nto import the schema definition that defined the foo section. Any\nimports are simply copied to the generated configuration file. When\nwe run the buildout:\n\n >>> print(system(buildout), end='') # doctest: +NORMALIZE_WHITESPACE\n Installing server.\n zc.zodbrecipes:\n A runzeo script couldn't be found at:\n <BLANKLINE>\n '/sample-buildout/bin/runzeo'\n <BLANKLINE>\n You may need to generate a runzeo script using the\n zc.recipe.eggs:script recipe and the ZEO egg, or you may need\n to specify the location of a script using the runzeo option.\n <BLANKLINE>\n Generated script '/sample-buildout/bin/server'.\n\nWe got a warning because the recipe expects there to be a runzeo\nscript and we haven't created one. This is done using the\nzc.recipe.egg:script recipe:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... ''')\n\n >>> print(system(buildout), end='') # doctest: +ELLIPSIS\n Installing zodb...\n Generated script '/sample-buildout/bin/runzeo'...\n Updating server.\n\nWe get 2 things. We get a directory in parts containing ZEO and\nzdaemon configuration files:\n\n >>> ls('parts', 'server')\n - zdaemon.conf\n - zeo.conf\n\nLet's look at the configuration files:\n\n >>> cat('parts', 'server', 'zeo.conf')\n %import foo\n <BLANKLINE>\n <zeo>\n address 8100\n monitor-address 8101\n transaction-timeout 300\n </zeo>\n <BLANKLINE>\n <foo>\n path /databases/Data.fs\n </foo>\n <BLANKLINE>\n <eventlog>\n <logfile>\n path STDOUT\n </logfile>\n </eventlog>\n\nWe see the same data we input with the addition of an eventlog section\nthat directs logging to standard out. In production, we'll use\nzdaemon's transacript log to capture this logging output in a file.\nIf we wish, we can specify a log file ourselves:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... <eventlog>\n ... <logfile>\n ... path /var/log/zeo.log\n ... </logfile>\n ... </eventlog>\n ... ''')\n\n >>> print(system(buildout), end='')\n Uninstalling server.\n Updating zodb.\n Installing server.\n Generated script '/sample-buildout/bin/server'.\n\n >>> cat('parts', 'server', 'zeo.conf')\n %import foo\n <BLANKLINE>\n <zeo>\n address 8100\n monitor-address 8101\n transaction-timeout 300\n </zeo>\n <BLANKLINE>\n <foo>\n path /databases/Data.fs\n </foo>\n <BLANKLINE>\n <eventlog>\n <logfile>\n path /var/log/zeo.log\n </logfile>\n </eventlog>\n\nBut we'll stick with the default:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... ''')\n\n >>> print(system(buildout), end='')\n Uninstalling server.\n Updating zodb.\n Installing server.\n Generated script '/sample-buildout/bin/server'.\n\nLet's look at the zdaemon log file:\n\n >>> cat('parts', 'server', 'zdaemon.conf')\n <runner>\n daemon on\n directory /sample-buildout/parts/server\n program /sample-buildout/bin/runzeo -C /sample-buildout/parts/server/zeo.conf\n socket-name /sample-buildout/parts/server/zdaemon.sock\n transcript /sample-buildout/parts/server/zeo.log\n </runner>\n <BLANKLINE>\n <eventlog>\n <logfile>\n path /sample-buildout/parts/server/zeo.log\n </logfile>\n </eventlog>\n\nWe run the runzeo script with the zeo.conf file. Log and run-time\nfiles are places in the server part directory. We use a transcript\nlog to provide the ZEO server log. I like to use the transacriot log\nbecause it captures program output, such as start-up exceptions that\naren't captured in a program's logs.\n\nAnd we get a control script generated in our bin directory:\n\n >>> cat('bin', 'server') # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS\n #!/usr/local/bin/python2.4\n <BLANKLINE>\n import sys\n sys.path[0:0] = [...]\n <BLANKLINE>\n <BLANKLINE>\n import zdaemon.zdctl\n <BLANKLINE>\n if __name__ == '__main__':\n sys.exit(zdaemon.zdctl.main([\n '-C', '/sample-buildout/parts/server/zdaemon.conf',\n ]+sys.argv[1:]\n ))\n\nThis is a zdaemon script. We can use this to control the ZEO server\nprocess.\n\nSpecifying additional eggs\n==========================\n\nYou can specify additional eggs to be installed for use by the\nzdaemon script:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... eggs = zope.event\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... ''')\n\n >>> print(system(buildout), end='')\n Uninstalling server.\n Updating zodb.\n Installing server.\n Generated script '/sample-buildout/bin/server'.\n\nWe can see the zope.event egg present in the control script\ngenerated in our bin directory:\n\n >>> cat('bin', 'server') # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS\n #!/usr/local/bin/python2.4\n <BLANKLINE>\n import sys\n sys.path[0:0] = [...]\n <BLANKLINE>\n import zdaemon.zdctl\n <BLANKLINE>\n if __name__ == '__main__':\n sys.exit(zdaemon.zdctl.main([\n '-C', '/sample-buildout/parts/server/zdaemon.conf',\n ]+sys.argv[1:]\n ))\n\nNB: This is a zdaemon script. If your ZEO server needs additional eggs, such as\n to provide additional storage types or log handlers, they should appear in\n [zodb] section in the above example, NOT the [server] section!\n\nUnix Deployment support\n=======================\n\nThe server recipe works with the zc.recipe.deployment. In particular,\nif a deployment option is specified, it names a part or section that\ndefines the following uptions:\n\ncrontab-directory\n A directory for crontab files.\n\netc-directory\n A directory for configuration files.\n\nlog-directory\n A directory for log files.\n\nlogrotate-directory\n A directory for logrotate configuration files.\n\nrc-directory\n A directory for run-control scripts.\n\nrun-directory\n A directory for run-time files.\n\nuser\n The user the server process should run as\n\nLet's create some directories and add a deployment section to our\nbuildout:\n\n >>> for d in 'cron', 'etc', 'log', 'rotate', 'rc', 'run':\n ... mkdir(d)\n ... globals()[d] = join(sample_buildout, d)\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %%import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... deployment = demo\n ...\n ... [demo]\n ... crontab-directory = %(cron)s\n ... etc-directory = %(etc)s\n ... log-directory = %(log)s\n ... logrotate-directory = %(rotate)s\n ... rc-directory = %(rc)s\n ... run-directory = %(run)s\n ... user = bob\n ... ''' % globals())\n\n >>> print(system(buildout), end='')\n Uninstalling server.\n Updating zodb.\n Installing server.\n Generated script '/sample-buildout/rc/demo-server'.\n\nNow, the parts directory and the control script will be gone:\n\n >>> import os\n >>> os.path.exists(join('parts', 'server'))\n False\n >>> os.path.exists(join('bin', 'server'))\n False\n\nInstead, the control script will be in the rc directory:\n\n >>> cat('rc', 'demo-server') # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS\n #!/usr/local/bin/python2.4\n <BLANKLINE>\n import sys\n sys.path[0:0] = [...]\n <BLANKLINE>\n import zdaemon.zdctl\n <BLANKLINE>\n if __name__ == '__main__':\n sys.exit(zdaemon.zdctl.main([\n '-C', '/sample-buildout/etc/server-zdaemon.conf',\n ]+sys.argv[1:]\n ))\n\nThe run-control script name now combines the deployment name and the\nscript name.\n\nand the configuration files will be in the etc directory:\n\n >>> ls('etc')\n - server-zdaemon.conf\n - server-zeo.conf\n\nLog rotation\n============\n\nIf a deployment is used, we'll also get a logrotate configuration file:\n\n >>> cat('rotate', 'demo-server')\n /sample-buildout/log/server-zeo.log {\n rotate 5\n weekly\n postrotate\n /sample-buildout/rc/demo-server -C /sample-buildout/etc/server-zdaemon.conf reopen_transcript\n endscript\n }\n\nThis will rotate the zeo log file once a week.\n\nIf we look at the zdaemon configuration file, we can see that it reflects\nthe deployment locations:\n\n >>> cat('etc', 'server-zdaemon.conf')\n <runner>\n daemon on\n directory /sample-buildout/run\n program /sample-buildout/bin/runzeo -C /sample-buildout/etc/server-zeo.conf\n socket-name /sample-buildout/run/server-zdaemon.sock\n transcript /sample-buildout/log/server-zeo.log\n user bob\n </runner>\n <BLANKLINE>\n <eventlog>\n <logfile>\n path /sample-buildout/log/server-zeo.log\n </logfile>\n </eventlog>\n\nNote that different file names are used. Since a deployment may be\n(and usually is) shared by multiple parts, files are prefixed with\ntheir part names. Also note that the deployment user is set in the\nzdaemon configuration.\n\nIf you want to manage your own log rotation, you can place \"logrotate = false\"\nin your deployment section to prevent the logrotate config being generated:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %%import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... deployment = demo\n ...\n ... [demo]\n ... logrotate = false\n ... crontab-directory = %(cron)s\n ... etc-directory = %(etc)s\n ... log-directory = %(log)s\n ... logrotate-directory = %(rotate)s\n ... rc-directory = %(rc)s\n ... run-directory = %(run)s\n ... user = bob\n ... ''' % globals())\n\n >>> print(system(buildout), end='')\n Uninstalling server.\n Updating zodb.\n Installing server.\n Generated script '/sample-buildout/rc/demo-server'.\n\nThe logrotate config is not there, but the rc script still is:\n\n >>> ls('rotate')\n >>> ls('rc')\n - demo-server\n\nIf it's more convenient, this can be placed in the [server] section instead:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %%import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... deployment = demo\n ... logrotate = false\n ...\n ... [demo]\n ... crontab-directory = %(cron)s\n ... etc-directory = %(etc)s\n ... log-directory = %(log)s\n ... logrotate-directory = %(rotate)s\n ... rc-directory = %(rc)s\n ... run-directory = %(run)s\n ... user = bob\n ... ''' % globals())\n\n >>> print(system(buildout), end='')\n Updating zodb.\n Updating server.\n\nThe logrotate config is not there, but the rc script still is:\n\n >>> ls('rotate')\n >>> ls('rc')\n - demo-server\n\nPacking cron job\n================\n\nWe can request definition of a cron job to pack the databases by\nspecifying a pack option. This option takes 5 to 7 values. The\nfirst 5 values are the time and date fields defined by Unix crontab\nfiles. The sixth field is the number of days in the past to pack to and\ndefaults to 1.\n\nLet's add a pack option:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %%import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... deployment = demo\n ... pack = 1 1 * * 0 3\n ...\n ... [demo]\n ... crontab-directory = %(cron)s\n ... etc-directory = %(etc)s\n ... log-directory = %(log)s\n ... logrotate-directory = %(rotate)s\n ... rc-directory = %(rc)s\n ... run-directory = %(run)s\n ... user = bob\n ... ''' % globals())\n\n >>> print(system(buildout+' -D'), end='')\n Uninstalling server.\n Updating zodb.\n Installing server.\n Generated script '/sample-buildout/rc/demo-server'.\n\nNow, we'll get a crontab file:\n\n >>> cat(cron, 'pack-demo-server')\n 1 1 * * 0 bob /sample-buildout/bin/zeopack -p 8100 -S 1 -d 3\n\n.. Make sure it works to supply a storage name:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %%import foo\n ... <foo x>\n ... path /databases/Data.fs\n ... </foo>\n ... deployment = demo\n ... pack = 1 1 * * 0 3\n ...\n ... [demo]\n ... crontab-directory = %(cron)s\n ... etc-directory = %(etc)s\n ... log-directory = %(log)s\n ... logrotate-directory = %(rotate)s\n ... rc-directory = %(rc)s\n ... run-directory = %(run)s\n ... user = bob\n ... ''' % globals())\n\n >>> _ = system(buildout+' -D'),\n\n >>> cat(cron, 'pack-demo-server')\n 1 1 * * 0 bob /sample-buildout/bin/zeopack -p 8100 -S x -d 3\n\n\nIn this example, we'll pack the databases every Sunday at 1:01 to 3\ndays.\n\nWe can add an email address to the pack option. If we do, then a\nMAILTO variable will be added to the cron file:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %%import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... deployment = demo\n ... pack = 1 1 * * 0 3 jim@zope.com\n ...\n ... [demo]\n ... crontab-directory = %(cron)s\n ... etc-directory = %(etc)s\n ... log-directory = %(log)s\n ... logrotate-directory = %(rotate)s\n ... rc-directory = %(rc)s\n ... run-directory = %(run)s\n ... user = bob\n ... ''' % globals())\n\n >>> print(system(buildout+' -D'), end='')\n Uninstalling server.\n Updating zodb.\n Installing server.\n Generated script '/sample-buildout/rc/demo-server'.\n\n >>> cat(cron, 'pack-demo-server')\n MAILTO=jim@zope.com\n 1 1 * * 0 bob /sample-buildout/bin/zeopack -p 8100 -S 1 -d 3\n\nThis causes email to be sent to the given address, rather than to the\nuser specified in the crontab file.\n\nshell start scripts\n===================\n\nBy default, the startup scripts are generated Python scripts that use\nthe zdaemon module. Sometimes, this is inconvenient. In particular,\nwhen deploying software, generated Python scripts may break after a\nsoftware update because they contain pasths to software eggs. We can\nrequest shell scripts that invoke a generic zdaemon script. The shell\nscript only depends on the path to the zdaemon script, which generally\ndoesn't change when updating softawre.\n\nTo request a shell script, add a shell-script option with a true\nvalue. We also need to cause a zdaemon script to be generated:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb zdaemon server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [zdaemon]\n ... recipe = zc.recipe.egg:script\n ... eggs = zdaemon\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %%import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... deployment = demo\n ... pack = 1 1 * * 0 3 jim@zope.com\n ... shell-script = true\n ...\n ... [demo]\n ... crontab-directory = %(cron)s\n ... etc-directory = %(etc)s\n ... log-directory = %(log)s\n ... logrotate-directory = %(rotate)s\n ... rc-directory = %(rc)s\n ... run-directory = %(run)s\n ... user = bob\n ... ''' % globals())\n\n >>> print(system(buildout+' -D'), end='')\n Uninstalling server.\n Updating zodb.\n Installing zdaemon.\n Generated script '/sample-buildout/bin/zdaemon'.\n Installing server.\n zc.zodbrecipes: Generated shell script '/sample-buildout/rc/demo-server'.\n\n >>> cat('rc', 'demo-server')\n #!/bin/sh\n su bob -c \\\n \"/sample-buildout/bin/zdaemon -C '/sample-buildout/etc/server-zdaemon.conf' $*\"\n\nNames\n=====\n\nNames can be specified for deployments and for individual server\nparts. These names determine names of files generated.\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb zdaemon server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [zdaemon]\n ... recipe = zc.recipe.egg:script\n ... eggs = zdaemon\n ...\n ... [server]\n ... name = Server\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... <zeo>\n ... address 8100\n ... monitor-address 8101\n ... transaction-timeout 300\n ... </zeo>\n ... %%import foo\n ... <foo>\n ... path /databases/Data.fs\n ... </foo>\n ... deployment = demo\n ... pack = 1 1 * * 0 3 jim@zope.com\n ... shell-script = true\n ...\n ... [demo]\n ... name = Demo\n ... crontab-directory = %(cron)s\n ... etc-directory = %(etc)s\n ... log-directory = %(log)s\n ... logrotate-directory = %(rotate)s\n ... rc-directory = %(rc)s\n ... run-directory = %(run)s\n ... user = bob\n ... ''' % globals())\n\n >>> print(system(buildout+' -D'), end='')\n Uninstalling server.\n Updating zodb.\n Updating zdaemon.\n Installing server.\n zc.zodbrecipes: Generated shell script '/sample-buildout/rc/Demo-Server'.\n\n >>> ls(cron)\n - pack-Demo-Server\n\n >>> ls(etc)\n - Server-zdaemon.conf\n - Server-zeo.conf\n\n >>> ls(rotate)\n - Demo-Server\n\n >>> ls(rc)\n - Demo-Server\n\nFeedback when you make mistakes\n===============================\n\nIf you make a mistake in your zeo.conf, some errors will result in a\nsimple, informative message being returned:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf =\n ... nothing useful\n ... ''')\n\n >>> print(system(buildout+' -q'), end='')\n Couldn't clean up '/sample-buildout/bin/server'.\n While:\n Installing server.\n Error: No zeo section was defined.\n\nIf your zeo.conf has a syntax error, you'll get shown the problematic\ntext and the message from the error:\n\n >>> write('buildout.cfg',\n ... '''\n ... [buildout]\n ... parts = zodb server\n ...\n ... [zodb]\n ... recipe = zc.recipe.egg:script\n ... eggs = ZEO\n ...\n ... [server]\n ... recipe = zc.zodbrecipes:server\n ... zeo.conf = <bad\n ... ''')\n\n >>> print(system(buildout+' -q'), end='')\n Couldn't clean up '/sample-buildout/bin/server'.\n While:\n Installing server.\n Error: malformed section start (line 1) in:\n <bad\n <BLANKLINE>\n\nDownload\n**********************\n",
"bugtrack_url": null,
"license": "ZPL 2.1",
"summary": "ZC Buildout recipes for ZODB",
"version": "3.1",
"project_urls": {
"Homepage": "https://github.com/zopefoundation/zc.zodbrecipes"
},
"split_keywords": [
"zodb",
"buildout"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa1b4318585303b142111b999c5ace4a7e8a23a6473eb3c44f9718f1d4913133",
"md5": "553e1b5b856f7125a6088b77503c2b32",
"sha256": "dc86d3a146422de2929e07c956a89103c933ec3ca3abeda0c318f9445fce1941"
},
"downloads": -1,
"filename": "zc.zodbrecipes-3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "553e1b5b856f7125a6088b77503c2b32",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 15275,
"upload_time": "2024-10-10T06:56:25",
"upload_time_iso_8601": "2024-10-10T06:56:25.908823Z",
"url": "https://files.pythonhosted.org/packages/aa/1b/4318585303b142111b999c5ace4a7e8a23a6473eb3c44f9718f1d4913133/zc.zodbrecipes-3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6324704724a7169afb3dedd328791c970552d34897819f6c03eba2c6ed5eb06c",
"md5": "d6121982e4af77fee9422537b296684c",
"sha256": "f8e2d9f4c9dbd01c0c3b03f0f0e45924c71f52b9997237de720a01b3818e2c4e"
},
"downloads": -1,
"filename": "zc.zodbrecipes-3.1.tar.gz",
"has_sig": false,
"md5_digest": "d6121982e4af77fee9422537b296684c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17935,
"upload_time": "2024-10-10T06:56:27",
"upload_time_iso_8601": "2024-10-10T06:56:27.225918Z",
"url": "https://files.pythonhosted.org/packages/63/24/704724a7169afb3dedd328791c970552d34897819f6c03eba2c6ed5eb06c/zc.zodbrecipes-3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 06:56:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zopefoundation",
"github_project": "zc.zodbrecipes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "zc.zodbrecipes"
}
JSON
