Repoze Quick Start

Repoze top-level applications can be installed within a virtualenv or by using zc.buildout . Either method is supported.

Repoze Quick Start via Virtualenv

  1. Create a virtualenv to House Your repoze.{grok,plone,zope2} Sandbox

    The Repoze installation routine depends on setuptools. 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 ez_setup.py using the a Python 2.4 interpreter that you'd like to use with a Repoze package.

    Please note that none of repoze.plone, repoze.zope2 or repoze.grok work properly under Python 2.5. These packages require Python 2.4.

    To to be able to create a repoze.{plone,plone,zope2} "sandbox" (an isolated Python environment), install the virtualenv 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:

            $ easy_install virtualenv
    

    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".

    As a non-root-user, create a virtualenv to house your sandbox (use any path other than /path/to/env that suits you):

            $ virtualenv --no-site-packages /path/to/env
    

    The --no-site-packages options ensures that the new Python virtual environment does not inherit any packages from the base Python installation.

  2. Post-Virtualenv-Creation Steps

    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.

    a) Post-Virtualenv-Creation Steps for repoze.plone

    The following commands create a repoze.plone sandbox environment, including Plone 3.0.1 and all its dependencies.

    cd into the virtual environment and install the repoze.plone package using the virtual environment's easy_install command:

               $ cd /path/to/env
               $ bin/easy_install -i http://dist.repoze.org/plone/latest/simple repoze.plone
    

    Once the repoze.plone 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 . Create a Plone site by using the "Plone Site" option from the "Add..." dropdown menu.

    b) Post-Virtualenv-Creation Steps for 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/zope2/latest/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

    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/grok/latest/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.

Repoze Quick Start via Buildout

repoze.plone and repoze.zope2 can also be installed via zc.buildout . For buildout configuration files, check out a buildout and run it. See the link for more information (each buildout includes a readme).