[Checkins] SVN: zc.async/trunk/ prepare for 1.5.0 release
Gary Poster
gary at modernsongs.com
Sun Sep 21 22:27:08 EDT 2008
Log message for revision 91301:
prepare for 1.5.0 release
Changed:
U zc.async/trunk/README.txt
U zc.async/trunk/setup.py
U zc.async/trunk/sphinx/.static/default.css
U zc.async/trunk/src/zc/async/CHANGES.txt
U zc.async/trunk/src/zc/async/QUICKSTART_1_VIRTUALENV.txt
U zc.async/trunk/src/zc/async/README_2.txt
U zc.async/trunk/src/zc/async/TODO.txt
U zc.async/trunk/src/zc/async/tips.txt
-=-
Modified: zc.async/trunk/README.txt
===================================================================
--- zc.async/trunk/README.txt 2008-09-22 00:16:23 UTC (rev 91300)
+++ zc.async/trunk/README.txt 2008-09-22 02:27:06 UTC (rev 91301)
@@ -1,5 +1,5 @@
-``zc.async``
-~~~~~~~~~~~~
+|zc.async|_
+~~~~~~~~~~~
===========
What is it?
@@ -53,3 +53,15 @@
The Twisted framework supplies some code (failures and reactor implementations,
primarily) and some concepts to the package.
+
+======================
+Where can I read more?
+======================
+
+Quickstarts and in-depth documentation are available in the package and in
+the `new and exciting on-line documentation`_.
+
+.. _`new and exciting on-line documentation`: http://packages.python.org/zc.async/1.5.0/
+.. |zc.async| image:: http://packages.python.org/zc.async/1.5.0/_static/zc_async.png
+.. _zc.async: http://packages.python.org/zc.async/1.5.0/
+
Modified: zc.async/trunk/setup.py
===================================================================
--- zc.async/trunk/setup.py 2008-09-22 00:16:23 UTC (rev 91300)
+++ zc.async/trunk/setup.py 2008-09-22 02:27:06 UTC (rev 91301)
@@ -72,14 +72,14 @@
setup(
name='zc.async',
- version='1.5.0b2',
+ version='1.5.0',
namespace_packages=['zc'],
packages=find_packages('src'),
package_dir={'':'src'},
package_data = {'': ['*.txt', '*.zcml']},
zip_safe=False,
author='Gary Poster',
- author_email='gary at modernsongs.com',
+ author_email='gary.poster at canonical.com',
description=
'Schedule durable tasks across multiple processes and machines.',
long_description=text(
Modified: zc.async/trunk/sphinx/.static/default.css
===================================================================
--- zc.async/trunk/sphinx/.static/default.css 2008-09-22 00:16:23 UTC (rev 91300)
+++ zc.async/trunk/sphinx/.static/default.css 2008-09-22 02:27:06 UTC (rev 91301)
@@ -589,8 +589,13 @@
/* "Footnotes" heading */
p.rubric {
- margin-top: 30px;
- font-weight: bold;
+ margin-top: 150px;
+ border-top: 30px solid #e6e6e6;
+ font-style: italic;
+ font-weight: bold;
+ font-family: "American Typewriter", Georgia, "Times New Roman", Times, serif;
+ padding-top: 10px;
+ padding-bottom: 20px;
}
/* "Topics" */
Modified: zc.async/trunk/src/zc/async/CHANGES.txt
===================================================================
--- zc.async/trunk/src/zc/async/CHANGES.txt 2008-09-22 00:16:23 UTC (rev 91300)
+++ zc.async/trunk/src/zc/async/CHANGES.txt 2008-09-22 02:27:06 UTC (rev 91301)
@@ -2,7 +2,7 @@
Changes
=======
-1.5.0 (2008-??-??)
+1.5.0 (2008-09-21)
==================
- Documentation improvements. Converted documentation into Sphinx system.
Modified: zc.async/trunk/src/zc/async/QUICKSTART_1_VIRTUALENV.txt
===================================================================
--- zc.async/trunk/src/zc/async/QUICKSTART_1_VIRTUALENV.txt 2008-09-22 00:16:23 UTC (rev 91300)
+++ zc.async/trunk/src/zc/async/QUICKSTART_1_VIRTUALENV.txt 2008-09-22 02:27:06 UTC (rev 91301)
@@ -17,7 +17,7 @@
.. sidebar:: ``virtualenv`` and ``zc.buildout``
I prefer |zc.buildout|_ for production deployments, but |virtualenv|_ is
- very nice for quick experimentation. Another quick-start uses
+ very nice for quick experimentation. The other quick-start uses
|zc.buildout|_.
::
@@ -175,13 +175,13 @@
------
This second part is policy, and if you ever put zc.async in production, you'll
-want to understand what's going on here. We'll talk about what's going on here
-a little later.
+want to understand what's going on here.
- >>> zc.async.configure.start(
- ... db, poll_interval=1)
+ >>> zc.async.configure.start(db, poll_interval=1)
-Now the system has a ``dispatcher`` polling for jobs every second.
+Now the system has a ``dispatcher`` polling for jobs every second. As we'll
+see below, a ``dispatcher`` polls for jobs in one or more queues, to assign
+them to worker threads.
Using |async|
=============
@@ -324,8 +324,8 @@
We've now seen some simple examples from the standard library. But how do you
get your own work done?
-Let's say we want to write an approach a chestnut of a problem: use a `Monte
-Carlo simulation`_ (read "throwing darts and analyzing the results") to
+Let's say we want to implement an old chestnut of a problem: use a `Monte
+Carlo simulation`_ (that is, "throwing darts and analyzing the results") to
`calculate pi`_. This will use |async| much like the map-reduce approach
of `Hadoop`_: we will want to distribute the work of running the simulation to
multiple machines so the result can be done faster.
Modified: zc.async/trunk/src/zc/async/README_2.txt
===================================================================
--- zc.async/trunk/src/zc/async/README_2.txt 2008-09-22 00:16:23 UTC (rev 91300)
+++ zc.async/trunk/src/zc/async/README_2.txt 2008-09-22 02:27:06 UTC (rev 91301)
@@ -24,6 +24,11 @@
you might expect, the configuration of a client process is a subset of the
configuration of the client/server process.
+The ``zc.async.configure`` module helps with basic configuration. The
+:ref:`quickstart-with-virtualenv` shows an example of using this for a very
+:quick start. The current text uses some of those conveniences, but focuses
+more on understanding the underlying patterns, rather than the conveniences.
+
We will first describe setting up a client, non-dispatcher process, in which
you only can put items in a zc.async queue; and then describe setting up a
dispatcher client/server process that can be used both to request and to
@@ -493,14 +498,17 @@
Configure the standard Python logging module as usual to send these logs where
you need. Be sure to auto-rotate the trace logs.
-The package supports monitoring using zc.z3monitor, but using this package
-includes more Zope 3 dependencies, so it is not included here. If you would
-like to use it, see monitor.txt in the package and our next section:
-:ref:`configuration-with-zope-3`. Otherwise, if you want to roll your own
-monitoring, glance at monitor.py--you'll see that most of the heavy lifting for
-the monitor support is done in the dispatcher, so it should be pretty easy to
-hook up the basic data another way.
+The package supports monitoring using zc.monitor. Using this package includes
+only a very few additional dependencies: zc.monitor, simplejson, and zc.ngi. An
+example of setting it up without Zope 3 is in the end of
+:ref:`quickstart-with-virtualenv`. If you would like to use it, see that
+document, monitor.txt in the package, and our next section:
+:ref:`configuration-with-zope-3`.
+Otherwise, if you want to roll your own monitoring, glance at monitor.py and
+monitordb.py--you'll see that you should be able to reuse most of the heavy
+lifting, so it should be pretty easy to hook up the basic data another way.
+
>>> reactor.stop()
.. rubric:: Footnotes
Modified: zc.async/trunk/src/zc/async/TODO.txt
===================================================================
--- zc.async/trunk/src/zc/async/TODO.txt 2008-09-22 00:16:23 UTC (rev 91300)
+++ zc.async/trunk/src/zc/async/TODO.txt 2008-09-22 02:27:06 UTC (rev 91301)
@@ -1,6 +1,3 @@
-- verify that main docs now show that zc.monitor has much fewer dependencies,
- so can be introduced without Zope 3.
-- fix up tips so that it looks better
- write a zc.buildout/grok quickstart
- would love a module-based API review of docs.
Modified: zc.async/trunk/src/zc/async/tips.txt
===================================================================
--- zc.async/trunk/src/zc/async/tips.txt 2008-09-22 00:16:23 UTC (rev 91300)
+++ zc.async/trunk/src/zc/async/tips.txt 2008-09-22 02:27:06 UTC (rev 91301)
@@ -73,6 +73,12 @@
doctests in this package, but should also be reasonably simple and
self-explanatory.
+More Tips and Tricks
+====================
+
+The following documents describe specific tips and tricks for specific
+situations.
+
.. toctree::
:maxdepth: 2
More information about the Checkins
mailing list