Installation and Running

It is easy to get a developer sandbox running for KARL3. (Deployment sandboxes are covered elsewhere.)

Before Installation

KARL3 is a repoze.bfg application, which means it needs Python and some core Python tools before starting.

1. If you haven’t made your own build of Python, download Python 2.5.x and compile it. Python 2.6.x might work (as might Python 2.4.x) , but 2.5.x is the deployment target, so that is the safest bet. It is also what most of the other developers use.
2. Make sure that your Python environment has setuptools installed, and that the correct easy_install is available in that environment.
3. Ditto for virtualenv. As the repoze.bfg docs explain, you can install virtualenv using easy_install.

These steps are fairly common for mainstream Python web development, meaning they are well-documented and reliable.

Installation

$ svn co http://osi.agendaless.com/bfgsvn/karlsample/trunk/ karl3
$ cd karl3
$ /path/to/your/python/bin/virtualenv --no-site-packages .
$ bin/python ./bootstrap.py
$ bin/buildout -U
$ bin/supervisord

After five or ten seconds, visit in your browser: http://localhost:6543/ and login as username admin and password admin.

Much more installation information is available in the README.txt at the top of the checkout.

Writable Checkouts

A writable checkout requires an SSH key to be registered in the KARL Subversion repository.

Once your key is added to the repository, check out the karlsample buildout as follows:

$ export KARLSVN=svn+ssh://osi@osi.agendaless.com/home/osi/bfgsvn
$ svn co $KARLSVN/karlsample/trunk karlsample

And then create the virtualenv and run the buildout as above:

$ cd karlsample
$ /path/to/correct/virtualenv --no-site-packages .
$ bin/python ./bootstrap.py
$ bin/buildout -U
$ bin/supervisord