[Repoze-checkins] r684 - www/trunk/kiss.repoze.org/content
Chris McDonough
chrism at agendaless.com
Tue Feb 12 01:01:55 UTC 2008
Author: Chris McDonough <chrism at agendaless.com>
Date: Mon Feb 11 20:01:55 2008
New Revision: 684
Log:
Remove references to repoze.project, document manual installation of virtualenv.
Modified:
www/trunk/kiss.repoze.org/content/quickstart.stx
Modified: www/trunk/kiss.repoze.org/content/quickstart.stx
==============================================================================
--- www/trunk/kiss.repoze.org/content/quickstart.stx (original)
+++ www/trunk/kiss.repoze.org/content/quickstart.stx Mon Feb 11 20:01:55 2008
@@ -1,73 +1,126 @@
-repoze Quick Start
+Repoze Quick Start
- repoze Quick Start
+ 1. Creating a virtualenv to House Your repoze.{grok,plone,zope2}
+ Sandbox <a name="creating_a_virtualenv"/>
- Up and Running with 'repoze.plone' <a name="repoze.plone" />
+ The Repoze installation routine depends on <a
+ href="http://peak.telecommunity.com/DevCenter/setuptools"
+ >setuptools</a>. You'll need to install that in your Python
+ environment before you are able to install any Repoze package.
+ Install setuptools by downloading and running <a
+ href="http://peak.telecommunity.com/dist/ez_setup.py">ez_setup.py</a>
+ using the a Python interpreter that you'd like to use with a
+ Repoze package.
- The 'repoze.project' helper application makes setting up a
- sandbox environment for a repoze-based application easy.
+ Please note that repoze.plone and repoze.zope2 *do not* work
+ under Python 2.5. Those packages require Python 2.4.
+ repoze.grok *does* work under Python 2.5 but also runs under 2.4
- The following commands create a 'repoze.plone'
- sandbox environment, including Plone 3.0.1 and all its dependencies.
- Assuming that you have already installed
- <a href="http://peak.telecommunity.com/DevCenter/setuptools"
- >setuptools</a> in your Python environment, you can just do::
+ To to be able to create a repoze.{plone,plone,zope2} "sandbox" (an
+ isolated Python environment), install the <a
+ href="http://pypi.python.org/pypi/virtualenv">virtualenv</a>
+ package. You may need to be a root user to do this if your Python
+ is the "system" Python::
- $ bin/easy_install -f http://dist.repoze.org/ repoze.project
- $ bin/repozeproject repoze.plone --path=/tmp/plone
+ $ easy_install virtualenv
- Once the 'repozeproject' command is finished processing, you may run the
- derived server by executing::
+ Virtualenv provides a way to create a "virtual" Python
+ installation, which makes it easy to evaluate and deploy packages
+ without potential conflict from libraries you've already installed
+ into your main Python's sys.path. Since repoze.plone and its
+ dependencies require lots of packages, virtualenv is a good way to
+ get a clean environment for your project. The virtualenv you
+ create will also serve "double duty" as a Repoze "instance home".
- $ cd /tmp/plone
- $ bin/addzope2user admin admin # create manager account
- $ bin/paster serve etc/zope2.ini
+ As a *non-root-user*, create a virtualenv to house your sandbox
+ (use any path other than '/path/to/env' that suits you)::
- Up and Running with 'repoze.zope2' <a name="repoze.zope2" />
+ $ virtualenv --no-site-packages /path/to/env
- The following commands create a 'repoze.zope2'
- sandbox environment, including Zope 2 and all its dependencies::
+ The '--no-site-packages' options ensures that the new Python
+ virtual environment does not inherit any packages from the base
+ Python installation.
- $ bin/easy_install -f http://dist.repoze.org/ repoze.project
- $ bin/repozeproject repoze.zope2 --path=/tmp/zope2
+ 2. Post-Virtualenv-Creation Steps
- Once the 'repozeproject' command is finished processing, you may run the
- derived server by executing::
+ The post-virtualenv-creation steps for installing repoze.zope2,
+ repoze.plone, and repoze.grok differ slightly. They are documented
+ below. Follow the steps for the repoze variant you're interested
+ in after installing your virtualenv.
- $ cd /tmp/zope2
- $ bin/addzope2user admin admin # create manager account
- $ bin/paster serve etc/zope2.ini
+ a) Post-Virtualenv-Creation Steps for 'repoze.plone' <a
+ name="repoze.plone"/>
- Up and Running with 'repoze.grok' <a name="repoze.grok" />
+ The following commands create a 'repoze.plone' sandbox
+ environment, including Plone 3.0.1 and all its dependencies.
- The following commands create a 'repoze.grok'
- sandbox environment, including grok and all its dependencies::
+ 'cd' into the virtual environment and install the 'repoze.plone'
+ package using the virtual environment's 'easy_install' command::
- $ bin/easy_install -f http://dist.repoze.org/ repoze.project
- $ bin/repozeproject repoze.grok --path=/tmp/grok
+ $ cd /path/to/env
+ $ bin/easy_install -i http://dist.repoze.org/simple repoze.plone
- Once the 'repozeproject' command is finished processing, you may run the
- derived server by executing::
+ Once the 'repoze.plone' package and its dependencies are
+ installed, you must create "instance" files using the
+ mkzope2instance script installed into the virtualenv::
- $ cd /tmp/grok
- $ cp etc/sample-users.zcml etc/users.zcml
- $ bin/paster serve etc/grok.ini
+ $ bin/mkzope2instance .
- Installing without 'setuptools' <a name="no_setuptools" />
+ Then you can then run the derived server by executing::
- If you don't already have
- <a href="http://peak.telecommunity.com/DevCenter/setuptools"
- >setuptools</a> installed in your Python, you can still try out
- 'repoze'. On a UNIX machine that has the capability of compiling
- Python software (e.g. gcc is installed and working and Python
- development libraries are installed)::
+ $ bin/addzope2user admin admin # create manager account
+ $ bin/paster serve etc/zope2.ini
- $ wget http://dist.repoze.org/repoze.project-0.0.4.tar.gz
- $ tar xzf repoze.project-0.0.4.tar.gz
- $ cd repoze.project-0.0.4/
- $ /path/to/bin/python setup.py install
+ Your setup is complete. You can log on to Zope at
+ http://localhost:8080/manage . Create a Plone site by using the
+ "Plone Site" option from the "Add..." dropdown menu.
+
+ b) Post-Virtualenv-Creation Steps for 'repoze.zope2' <a
+ name="repoze.zope2" />
+
+ The following commands create a 'repoze.zope2' sandbox
+ environment, including Zope 2 and all of its dependencies::
+
+ $ cd /path/to/env
+ $ bin/easy_install -i http://dist.repoze.org/simple repoze.zope2
+
+ Once the 'repoze.zope2' package and its dependencies are
+ installed, you must create 'instance' files using the
+ mkzope2instance script installed into the virtualenv::
+
+ $ bin/mkzope2instance .
+
+ Then you can then run the derived server by executing::
+
+ $ bin/addzope2user admin admin # create manager account
+ $ bin/paster serve etc/zope2.ini
+
+ Your setup is complete. You can log on to Zope at
+ http://localhost:8080/manage .
+
+ c) Post-Sandbox-Creation Steps for 'repoze.grok' <a
+ name="repoze.grok" />
+
+ The following commands create a 'repoze.grok' sandbox
+ environment, including grok 0.11 and all its dependencies::
+
+ $ cd /path/to/env
+ $ bin/easy_install -i http://dist.repoze.org/simple repoze.grok
+
+ Once the 'repoze.grok' package and its dependencies are
+ installed, you must create 'instance' files using the
+ mkgrokinstance script installed into the virtualenv::
+
+ $ bin/mkgrokinstance .
+
+ Then you can then run the derived server by executing::
+
+ $ cp etc/sample-users.zcml etc/users.zcml
+ $ bin/paster serve etc/grok.ini
+
+ Your setup is complete. You can log on to Grok at
+ http://localhost:8080/ using the account and password defined in
+ the users.zcml file.
- At that point, you should be able to run the 'repozeproject'
- script as outlined above.
More information about the Repoze-checkins
mailing list