[Checkins] SVN: bluebream/trunk/docs/source/tutorial.rst update "Starting new project" section
Baiju M
baiju.m.mail at gmail.com
Sat Jan 9 21:42:24 EST 2010
Log message for revision 107969:
update "Starting new project" section
Changed:
U bluebream/trunk/docs/source/tutorial.rst
-=-
Modified: bluebream/trunk/docs/source/tutorial.rst
===================================================================
--- bluebream/trunk/docs/source/tutorial.rst 2010-01-10 02:15:34 UTC (rev 107968)
+++ bluebream/trunk/docs/source/tutorial.rst 2010-01-10 02:42:24 UTC (rev 107969)
@@ -104,11 +104,51 @@
later, if you desired later. But changing the package name or
namespace package name may not be as simple as changing the
description as it is referred from many places.
-
-Ticket Collector: Your first BlueBream application
---------------------------------------------------
+If you change directory to ``ticketcollector``, you can see few
+directories and files::
+ jack at computer:/projects/ticketcollector$ ls -CF
+ bootstrap.py debug.ini etc/ src/ var/
+ buildout.cfg deploy.ini setup.py templates/ versions.cfg
+
+Once the project directory layout is ready, you can add it to your
+version controlling system. After that, you need to bootstrap
+Buildout and run ``buildout`` command to build the application. The
+purpose of Buildout is to automate all the process involved in
+bulding an Python application/package from scratch. The only basic
+requirement for Buildout is a Python installation. Buildout provides
+a bootstrapping script to to initialize Buildout. This bootstrap
+script named "bootstrap.py" will do these things:
+
+- Download and install ``setuptools`` package from PyPI
+- Download and install ``zc.buildout`` package fron PyPI
+- Create directory struture eg:- bin/ eggs/ parts/ develop-eggs/
+- Create a script inside ``bin`` directory named ``buildout``
+
+When you run the ``bootstrap.py``, you can see that it creates few
+directories and the ``bin/buildout`` script as mentioned::
+
+ jack at computer:/projects/ticketcollector$ python2.6 bootstrap.py
+ Creating directory '/projects/ticketcollector/bin'.
+ Creating directory '/projects/ticketcollector/parts'.
+ Creating directory '/projects/ticketcollector/develop-eggs'.
+ Creating directory '/projects/ticketcollector/eggs'.
+ Generated script '/projects/ticketcollector/bin/buildout'.
+
+- The ``bin`` directory is where buildout install all the executable
+ scripts.
+
+- The ``eggs`` directory is where buildout install Python eggs
+
+- The ``parts`` is where Buildout save all output generated by buildout.
+ Buildout expects you to not change anything inside parts directory
+ as it is autogenerated by Buildout.
+
+- The ``develop-eggs`` directory is where buildout save links to all
+ locally develping Python eggs.
+
+
Creating the application object
-------------------------------
More information about the checkins
mailing list