[Checkins] SVN: grokproject/trunk/ update changelog and readme to elaborate on structural changes in the versions info layout and the interactive debug promtp
janwijbrand at gmail.com
Thu May 20 11:10:14 EDT 2010
Log message for revision 112579:
update changelog and readme to elaborate on structural changes in the versions info layout and the interactive debug promtp
--- grokproject/trunk/CHANGES.txt 2010-05-20 14:40:12 UTC (rev 112578)
+++ grokproject/trunk/CHANGES.txt 2010-05-20 15:10:14 UTC (rev 112579)
@@ -4,6 +4,26 @@
+* Use a new "version information" layout on http://grok.zope.org/releaseinfo.
+ More specifically, the "bundlemaker" or "eggbasket" feature is no longer
+ used. Instead, grokproject expexts to find a
+ http://grok.zope.org/releaseinfo/[y.x]/versions.cfg file and a
+ http://grok.zope.org/releaseinfo/[y.x]/eggs directory containing
+ distributions for all the dependencies of grok.
+ This "eggs" directory is used by way of the ``find-links`` directive in the
+ ``buildout.cfg`` of newly created projects.
+ The ``versions.cfg`` file extends the groktoolkit files that in turn extend
+ from the zopetoolkit cfg files. The newly created project will have an
+ ``extends-cache`` directive set, in order to support "off-line" building (as
+ long as no new packages are required for building).
+ **NOTE: As a result of these structural changes, ``grokproject`` will no
+ longer support building projects based on Grok versions earlier than 1.1.1
+ (or earlier than 1.0.2, for the 1.0-line of Grok releases).**
* Remove the interactive debugger entry point in favor of a buildout part
that generates a similar commandline tool for the newly created project.
--- grokproject/trunk/README.txt 2010-05-20 14:40:12 UTC (rev 112578)
+++ grokproject/trunk/README.txt 2010-05-20 15:10:14 UTC (rev 112579)
@@ -16,12 +16,11 @@
... many lines of output here
This will not only create a project area for you to work in, it will
-also download and install Grok and Zope 3 (the application server Grok
-is built on).
+also download and install Grok and its dependencies.
-After the project area has been created successfully, you will find an
-empty Python package in the ``src`` directory in which you can place
-the code for your web application.
+After the project area has been created successfully, you will find an empty
+Python package "skeleton" in the ``src`` directory in which you can place the
+code for your web application.
To start the application server, execute::
@@ -32,15 +31,22 @@
$ bin/paster serve parts/etc/deploy.ini --daemon
-There is also an Ajax enabled debugger
-(point your browser to http://localhost:8080/@@login.html when using this)::
+There is also an Ajax enabled debugger (point your browser to
+http://localhost:8080/@@login.html when using this)::
$ bin/paster serve parts/etc/debug.ini
-Start the interactive debugger::
+To start the interactive debugger prompt::
+To run an ad-hoc Python script againsy a full setup application::
+ $ bin/interactive_debugger [name_of_python_script].py
+Python scripts run this way, will have access to a ``root``, ``debugger``, and
+an ``app`` object avaible for "interacting" with the application environment.
For those who know paster: ``grokproject`` is just a wrapper around a
paster template. So instead of running the ``grokproject`` command,
you can also run::
@@ -48,10 +54,10 @@
$ paster create -t grok MammotHerd
All configuration files used for running Grok can be found in the
-``parts/etc/`` directory of your project. These configuration files
-are generated automatically from the templates in ``etc/`` on each
-``buildout`` run. To modify the configuration files edit the
-approriate templates in ``etc/`` and rerun ``buildout`` afterwards::
+``parts/etc/`` directory of your project. These configuration files are
+generated automatically from the templates in ``etc/`` on each ``buildout``
+run. To modify the configuration files edit the approriate templates in
+``etc/`` and rerun ``buildout`` afterwards::
More information about the checkins