[Repoze-checkins] r1028 - www/trunk/kiss.repoze.org/content
Chris McDonough
chrism at agendaless.com
Mon May 12 02:00:14 EDT 2008
Author: Chris McDonough <chrism at agendaless.com>
Date: Mon May 12 02:00:14 2008
New Revision: 1028
Log:
Mention buildout.
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 May 12 02:00:14 2008
@@ -1,127 +1,138 @@
-Repoze Quick Start via Virtualenv
+Repoze Quick Start
- 1. **Creating a virtualenv to House Your repoze.{grok,plone,zope2}
- Sandbox <a name="creating_a_virtualenv"/>**
+ Repoze top-level applications can be installed within a virtualenv
+ or by using "zc.buildout":http://pypi.python.org/pypi/zc.buildout .
+ Either method is supported.
- 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 2.4 interpreter that you'd like to use with a
- Repoze package.
+ Repoze Quick Start via Virtualenv
- Please note that none of repoze.plone, repoze.zope2 or repoze.grok
- work properly under Python 2.5. **These packages require Python
- 2.4.**
+ 1. **Create a virtualenv to House Your repoze.{grok,plone,zope2}
+ Sandbox <a name="creating_a_virtualenv"/>**
- 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 using the setuptools 'easy_install' command. You may need
- to be a root user to do this if your Python is the "system"
- Python::
+ 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 2.4 interpreter that you'd like to use with a
+ Repoze package.
- $ easy_install virtualenv
+ Please note that none of repoze.plone, repoze.zope2 or repoze.grok
+ work properly under Python 2.5. **These packages require Python
+ 2.4.**
- 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".
+ 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 using the setuptools 'easy_install' command. You may need
+ to be a root user to do this if your Python is the "system"
+ Python::
- As a *non-root-user*, create a virtualenv to house your sandbox
- (use any path other than '/path/to/env' that suits you)::
+ $ easy_install virtualenv
- $ virtualenv --no-site-packages /path/to/env
+ 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".
- The '--no-site-packages' options ensures that the new Python
- virtual environment does not inherit any packages from the base
- Python installation.
+ As a *non-root-user*, create a virtualenv to house your sandbox
+ (use any path other than '/path/to/env' that suits you)::
- 2. **Post-Virtualenv-Creation Steps**
+ $ virtualenv --no-site-packages /path/to/env
- 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.
+ The '--no-site-packages' options ensures that the new Python
+ virtual environment does not inherit any packages from the base
+ Python installation.
- a) **Post-Virtualenv-Creation Steps for 'repoze.plone' <a
- name="repoze.plone"/>**
+ 2. **Post-Virtualenv-Creation Steps**
- The following commands create a 'repoze.plone' sandbox
- environment, including Plone 3.0.1 and all its dependencies.
+ 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' into the virtual environment and install the 'repoze.plone'
- package using the virtual environment's 'easy_install' command::
+ a) Post-Virtualenv-Creation Steps for 'repoze.plone' <a
+ name="repoze.plone"/>
- $ cd /path/to/env
- $ bin/easy_install -i http://dist.repoze.org/plone/latest repoze.plone
+ The following commands create a 'repoze.plone' sandbox
+ environment, including Plone 3.0.1 and all its dependencies.
- Once the 'repoze.plone' package and its dependencies are
- installed, you must create "instance" files using the
- mkzope2instance script installed into the virtualenv::
+ 'cd' into the virtual environment and install the 'repoze.plone'
+ package using the virtual environment's 'easy_install' command::
- $ bin/mkzope2instance .
+ $ cd /path/to/env
+ $ bin/easy_install -i http://dist.repoze.org/plone/latest repoze.plone
- Then you can then 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::
- $ bin/addzope2user admin admin # create manager account
- $ bin/paster serve etc/zope2.ini
+ $ bin/mkzope2instance .
- 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.
+ Then you can then run the derived server by executing::
- b) **Post-Virtualenv-Creation Steps for 'repoze.zope2' <a
- name="repoze.zope2" />**
+ $ bin/addzope2user admin admin # create manager account
+ $ bin/paster serve etc/zope2.ini
- The following commands create a 'repoze.zope2' sandbox
- environment, including Zope 2 and all of its dependencies::
+ 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.
- $ cd /path/to/env
- $ bin/easy_install -i http://dist.repoze.org/zope2/latest repoze.zope2
+ b) Post-Virtualenv-Creation Steps for 'repoze.zope2' <a
+ name="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::
+ The following commands create a 'repoze.zope2' sandbox
+ environment, including Zope 2 and all of its dependencies::
- $ bin/mkzope2instance .
+ $ cd /path/to/env
+ $ bin/easy_install -i http://dist.repoze.org/zope2/latest repoze.zope2
- Then you can then run the derived server by executing::
+ Once the 'repoze.zope2' package and its dependencies are
+ installed, you must create 'instance' files using the
+ mkzope2instance script installed into the virtualenv::
- $ 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 .
+ $ bin/mkzope2instance .
- c) **Post-Sandbox-Creation Steps for 'repoze.grok' <a
- name="repoze.grok" />**
+ Then you can then run the derived server by executing::
- The following commands create a 'repoze.grok' sandbox
- environment, including grok 0.11 and all its dependencies::
+ $ 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 .
- $ cd /path/to/env
- $ bin/easy_install -i http://dist.repoze.org/grok/latest repoze.grok
+ c) Post-Sandbox-Creation Steps for 'repoze.grok' <a
+ name="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::
+ The following commands create a 'repoze.grok' sandbox
+ environment, including grok 0.11 and all its dependencies::
- $ bin/mkgrokinstance .
+ $ cd /path/to/env
+ $ bin/easy_install -i http://dist.repoze.org/grok/latest repoze.grok
- Then you can then run the derived server by executing::
+ Once the 'repoze.grok' package and its dependencies are
+ installed, you must create 'instance' files using the
+ mkgrokinstance script installed into the virtualenv::
- $ cp etc/sample-users.zcml etc/users.zcml
- $ bin/paster serve etc/grok.ini
+ $ bin/mkgrokinstance .
- 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.
+ 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.
+ Repoze Quick Start via Buildout
+
+ repoze.plone and repoze.zope2 can also be installed via
+ "zc.buildout":http://pypi.python.org/pypi/zc.buildout . For
+ buildout configuration files, "check out a
+ buildout":http://svn.repoze.org/buildouts/ and run it. See the
+ link for more information (each buildout includes a readme).
More information about the Repoze-checkins
mailing list