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

Last change on this file since 11102 was 4944, checked in by uli, 15 years ago

Update docs.

File size: 2.4 KB
Line 
1waeup.sirp
2**********
3
4The WAeUP Student Information and Registration Portal. `waeup.sirp` is
5a web-based management tool for managing universities and schools.
6
7What is ``waeup.sirp``?
8=======================
9
10The package was created as an effort of the WAeUP group. See
11http://www.waeup.org to learn more about WAeUP.
12
13
14Installation
15============
16
17.. note:: ``waeup.sirp`` does not work with Python > 2.5
18          currently. Use of Python 2.5 is recommended.
19
20.. note:: ``waeup.sirp`` does not work on Windows.
21
22Prerequisites
23-------------
24
25The ``waeup.sirp`` package is based on `Grok`_, which is a Python
26framework for agile webapplication development. Grok itself is based
27on `Zope`_.
28
29.. _Grok: http://grok.zope.org/
30
31.. _Zope: http://www.zope.org/
32
33To deploy ``waeup.sirp`` most easily, we use `zc.buildout`_
34
35.. _zc.buildout: http://cheeseshop.python.org/pypi/zc.buildout
36
37You may have setuptools already installed for your system Python. In
38that case, you may need to upgrade it first because buildout requires
39a very recent version::
40
41    $ sudo easy_install -U setuptools
42
43If this command fails because easy_install is not available, there is
44a good chance you do not have setuptools available for your system
45Python. If so, there is no problem because setuptools will be
46installed locally by buildout.
47
48Bootstrap the buildout environment::
49
50    $ python2.4 bootstrap/bootstrap.py
51
52and run the buildout command::
53
54    $ bin/buildout
55    [lots of stuff will be downloaded and installed here]
56
57Note that if you have more than one sandbox for a Zope-based web
58application, it will probably make sense to share the eggs between the
59different sandboxes.  You can tell ``zc.buildout`` to use a central
60eggs directory by creating ``~/.buildout/default.cfg`` with the
61following contents::
62
63    [buildout]
64    eggs-directory = /home/bruno/buildout-eggs
65
66Running the ``waeup`` application
67---------------------------------
68
69You can start Zope with the with the following command:
70
71    $ bin/zopectl fg
72
73If you now connect to port 8080 and log in with username 'grok',
74password 'grok', you should be able to add the grok-based applications
75(such as ``waeup``) from the menu.
76
77Add an instance of ``waeup`` and click on the link next to the then
78visible entry in the list of installed applications.
79
80Running the tests
81-----------------
82
83The tests are easily run by executing the test runner that's
84installed in the ``bin`` directory::
85
86    $ bin/test
87
Note: See TracBrowser for help on using the repository browser.