[Checkins] SVN: bluebream/trunk/src/bluebream/bluebream_base/ Added a README.txt file in the template, give the version of bluebream used

Christophe Combelles ccomb at free.fr
Tue Jul 27 20:32:13 EDT 2010


Log message for revision 115134:
  Added a README.txt file in the template, give the version of bluebream used
  during creation, and some hints to start, debug and test the application
  
  

Changed:
  A   bluebream/trunk/src/bluebream/bluebream_base/project_template/README.txt_tmpl
  U   bluebream/trunk/src/bluebream/bluebream_base/project_template/buildout.cfg_tmpl
  U   bluebream/trunk/src/bluebream/bluebream_base/template.py
  U   bluebream/trunk/src/bluebream/bluebream_base/tests/bluebream.txt

-=-
Added: bluebream/trunk/src/bluebream/bluebream_base/project_template/README.txt_tmpl
===================================================================
--- bluebream/trunk/src/bluebream/bluebream_base/project_template/README.txt_tmpl	                        (rev 0)
+++ bluebream/trunk/src/bluebream/bluebream_base/project_template/README.txt_tmpl	2010-07-28 00:32:13 UTC (rev 115134)
@@ -0,0 +1,58 @@
+${'='*len(project)}
+${project}
+${'='*len(project)}
+
+(Document the ${project} project here.)
+This project has been initially created with Bluebream version ${created_with}
+
+Installation
+============
+
+Run the following steps::
+
+  $$ python bootstrap.py
+  $$ bin/buildout
+
+If you have an error during the buildout process, you probably miss some
+dependencies (development libs, tools and headers).
+
+Tests
+=====
+
+Run::
+
+  $$ bin/test
+
+
+Debugging
+=========
+
+To start a python interpreter with the same environment as your project, run::
+
+  $$ bin/breampy
+
+To start a python interpreter with the same environment as  your project and
+with access to the ZODB database, run::
+
+  $$ bin/paster shell debug.ini # or deploy.ini
+
+Here, you can access the root folder through the `root` variable, and a debugger
+object through variable `debugger` or `app`. This object allows you to simulate
+requests to the application and to access the ZODB root object.
+
+Startup
+=======
+
+Check the WSGI configuration in deploy.ini and debug.ini
+
+During development, run the following command to run the server::
+
+  $$ bin/paster serve debug.ini
+
+For deployment, run::
+
+  $$ bin/paster serve --daemon deploy.ini
+
+and use a process monitoring tool such as supervisord.
+
+

Modified: bluebream/trunk/src/bluebream/bluebream_base/project_template/buildout.cfg_tmpl
===================================================================
--- bluebream/trunk/src/bluebream/bluebream_base/project_template/buildout.cfg_tmpl	2010-07-27 23:45:34 UTC (rev 115133)
+++ bluebream/trunk/src/bluebream/bluebream_base/project_template/buildout.cfg_tmpl	2010-07-28 00:32:13 UTC (rev 115134)
@@ -1,3 +1,4 @@
+# ${created_with}
 [buildout]
 develop = .
 extends = http://download.zope.org/bluebream/bluebream-${bluebream}.cfg

Modified: bluebream/trunk/src/bluebream/bluebream_base/template.py
===================================================================
--- bluebream/trunk/src/bluebream/bluebream_base/template.py	2010-07-27 23:45:34 UTC (rev 115133)
+++ bluebream/trunk/src/bluebream/bluebream_base/template.py	2010-07-28 00:32:13 UTC (rev 115134)
@@ -125,6 +125,8 @@
             print "Please choose a different project name."
             sys.exit(1)
         vars['zip_safe'] = False
+        # remember the version of bluebream used to create the project
+        vars['created_with'] = current
         return vars
 
     def pre(self, command, output_dir, vars):

Modified: bluebream/trunk/src/bluebream/bluebream_base/tests/bluebream.txt
===================================================================
--- bluebream/trunk/src/bluebream/bluebream_base/tests/bluebream.txt	2010-07-27 23:45:34 UTC (rev 115133)
+++ bluebream/trunk/src/bluebream/bluebream_base/tests/bluebream.txt	2010-07-28 00:32:13 UTC (rev 115134)
@@ -65,6 +65,7 @@
 <BLANKLINE>
 
 >>> print_dir('sample')
+sample/README.txt
 sample/bootstrap.py
 sample/buildout.cfg
 sample/debug.ini
@@ -132,6 +133,7 @@
 ...
 
 >>> print_dir('sample.main')
+sample.main/README.txt
 sample.main/bootstrap.py
 sample.main/buildout.cfg
 sample.main/debug.ini
@@ -205,6 +207,7 @@
 ...
 
 >>> print_dir('sample.app.main')
+sample.app.main/README.txt
 sample.app.main/bootstrap.py
 sample.app.main/buildout.cfg
 sample.app.main/debug.ini
@@ -278,6 +281,7 @@
 ...
 
 >>> print_dir('foobar.foobar')
+foobar.foobar/README.txt
 foobar.foobar/bootstrap.py
 foobar.foobar/buildout.cfg
 foobar.foobar/debug.ini
@@ -348,6 +352,7 @@
 ...
 
 >>> print_dir('sampleproject')
+sampleproject/README.txt
 sampleproject/bootstrap.py
 sampleproject/buildout.cfg
 sampleproject/debug.ini



More information about the checkins mailing list