source: main/waeup.sirp/branches/ulif-paster/README.txt @ 11102

waeup.sirp
**********

The WAeUP Student Information and Registration Portal. `waeup.sirp` is
a web-based management tool for managing universities and schools.

What is ``waeup.sirp``?
=======================

The package was created as an effort of the WAeUP group. See
http://www.waeup.org to learn more about WAeUP.


Installation
============

.. note:: ``waeup.sirp`` might not work with Python > 2.5
          currently. Use of Python 2.5 is recommended.

.. note:: ``waeup.sirp`` does not work on Windows.

Prerequisites
-------------

The ``waeup.sirp`` package is based on `Grok`_, which is a Python
framework for agile webapplication development. Grok itself is based
on `Zope`_.

.. _Grok: http://grok.zope.org/

.. _Zope: http://www.zope.org/

Both, Grok and Zope, are written in Python (with parts written in
C). You therefore need `Python`_ installed.

.. _Python: http://www.python.org/

Note, that you also need the Python header files and a compiler to
compile the parts written in C.

To deploy ``waeup.sirp`` most easily, we use `zc.buildout`_

.. _zc.buildout: http://cheeseshop.python.org/pypi/zc.buildout

You may have setuptools already installed for your system Python. In
that case, you may need to upgrade it first because buildout requires
a very recent version::

    $ sudo easy_install -U setuptools

If this command fails because easy_install is not available, there is
a good chance you do not have setuptools available for your system
Python. If so, there is no problem because setuptools will be
installed locally by buildout.

Bootstrap the buildout environment::

    $ python2.5 bootstrap/bootstrap.py

and run the buildout command::

    $ bin/buildout
    [lots of stuff will be downloaded and installed here]

Note that if you have more than one sandbox for a Zope-based web
application, it will probably make sense to share the eggs between the
different sandboxes.  You can tell ``zc.buildout`` to use a central
eggs directory by creating ``~/.buildout/default.cfg`` with the
following contents::

    [buildout]
    eggs-directory = /home/bruno/buildout-eggs

Running the ``waeup`` application
---------------------------------

You can start Zope with the with the following command:

    $ bin/sirpctl fg

Alternatively you can do:

    $ bin/paster serve parts/etc/deploy.ini

If you now connect to port 8080 and log in with username 'grok',
password 'grok', you should be able to add the grok-based applications
(such as ``University``) from the menu.

Add an instance of ``University`` and click on the link next to the
then visible entry in the list of installed applications.

Running the tests
-----------------

The tests are easily run by executing the test runner that's
installed in the ``bin`` directory::

    $ bin/test