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

Last change on this file since 11110 was 5492, checked in by uli, 14 years ago

Update docs.

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