source: main/waeup.sirp/branches/ulif-paster/docs/INSTALL.txt @ 11072

Last change on this file since 11072 was 5341, checked in by uli, 14 years ago

Add main INSTALL.txt

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