CreativeCommons Licence
+CreativeCommons Licence
The RRZE Icon Set is licenced under a Creative Commons Licence. Please see the website for the current licence text.
+More information about the Project could be found here: +http://rrze-icon-set.berlios.de/licence.html
+Special thanks to: +* Franziska Sponsel (created additional Icons specially for our Project)
>>> bootstrap.py
->>> bin/buildout
+Run the Installation from a Shell (not Python)
++- - +$ bootstrap.py +$ bin/buildout
>>> bin/test
+Vertify that everything was setup correclty and your branch fullfills the version requirements by running it’s own test module
++- - +$ bin/test
>>> bin/mailman
+Now you’re able to run mailman using
++- - +$ bin/mailman
Next thing you need to do is installing the Plugin used for communication with non-mailman-code parts like our WebUI. Within the Client Branch we’ve put both, Classes to access the Core which are run as a Plugin and some Python Bindings. The Python Bindings were used later on within our Django Application to access the Server. Failing to install the Client would result in an offline version of WebUI
Once again start by branching the code which is on Launchpad
->>> bzr branch lp:mailman.client
+
+$ bzr branch lp:mailman.client
+
Note
We’ve successfully tested our functionality with Revision 16 - In case the Client gets updated which it surely will in future we can’t guarentee that it is compatible anymore.
As you only want to run the Client and not modify it’s code you’re fine with running the install command from within the directory. At the moment this requires Sudo Priveledges as files will copied to the Python Site-Packages Directory which is available to all users.
->>> sudo python setup.py install
+
+$ sudo python setup.py install
+
Note
-If you want to change parts of the Client you can use the development option which will create a Symlink instead of a Hardcopy of all files:
-
->>> sudo python setup.py develop
+If you want to change parts of the Client you can use the development option which will create a Symlink instead of a Hardcopy of all files:
+$ sudo python setup.py develop
+
All changes will apply once you restart Mailman itself.
@@ -239,40 +240,50 @@
‘django.contrib.sites’,
‘django.contrib.admin’,
‘mailman_django’,
-
+
Note
-Makes sure that Django knows about our directory as an App and creates needed Tables () when
+Makes sure that Django knows about our directory as an App and creates needed Tables () when running
+
+$ python manage.py syncdb
+
->>> running manage.py syncdb
-
-
Now that you know about all these you might start the development server. As usual in Django this is done by running
->>> python manage.py runserver
+
+$ python manage.py runserver
+
within the Django Site Directory - as usual the default address is localhost:8000
Of course it will only be able to start once our app is in place as well.
Django Application¶
First get the files, and make sure you paste them into your Project directory and adjust it’s name to the appropriate configuration you’ve made earlier in the Django Site. Remeber our default is mailman_django
->>> bzr branch lp:mailmanwebgsoc2011
+
+$ bzr branch lp:mailmanwebgsoc2011
+
Note
We’ve tested Revision 172
+
+Note
+We’re planning to ease up installation by creating an egg
+
Test the Sites functionality¶
We’ve added our own test-suite to the Django App which will be executed together with the Django Test. Last thing you should do is running these tests. If they fail you did something wrong, if they succeed you can enjoy the site.
Run the following in the Site Directory
->>> python manage.py test
+
+$ python manage.py test
+
Note
Please be aware that we want to run a development instance of mailman you need to stop the stable one first and the tests will open it’s own mailman temporily.
diff --git a/doc/setup.rst b/doc/setup.rst
index f5ef626..1ed7d64 100644
--- a/doc/setup.rst
+++ b/doc/setup.rst
@@ -12,12 +12,23 @@
.. note::
Please be aware that the following steps only work if you're really in that DIR. If you consider adding a subfolder name to the commands those woun't work !
* Run the Installation from a Shell (not Python)
- >>> bootstrap.py
- >>> bin/buildout
+
+ .. code-block:: bash
+
+ $ bootstrap.py
+ $ bin/buildout
+
* Vertify that everything was setup correclty and your branch fullfills the version requirements by running it's own test module
- >>> bin/test
+
+ .. code-block:: bash
+
+ $ bin/test
+
* Now you're able to run mailman using
- >>> bin/mailman
+
+ .. code-block:: bash
+
+ $ bin/mailman
Mailman Client / REST Api
-------------------------
@@ -27,18 +38,25 @@
Once again start by branching the code which is on Launchpad
->>> bzr branch lp:mailman.client
+ .. code-block:: bash
+
+ $ bzr branch lp:mailman.client
.. note::
We've successfully tested our functionality with Revision 16 - In case the Client gets updated which it surely will in future we can't guarentee that it is compatible anymore.
As you only want to run the Client and not modify it's code you're fine with running the install command from within the directory. At the moment this requires Sudo Priveledges as files will copied to the Python Site-Packages Directory which is available to all users.
->>> sudo python setup.py install
+ .. code-block:: bash
+
+ $ sudo python setup.py install
.. note::
If you want to change parts of the Client you can use the development option which will create a Symlink instead of a Hardcopy of all files:
->>> sudo python setup.py develop
+
+ .. code-block:: bash
+
+ $ sudo python setup.py develop
All changes will apply once you restart Mailman itself.
@@ -139,12 +157,17 @@
'mailman_django',
.. note::
- Makes sure that Django knows about our directory as an App and creates needed Tables () when
->>> running manage.py syncdb
+ Makes sure that Django knows about our directory as an App and creates needed Tables () when running
+
+ .. code-block:: bash
+
+ $ python manage.py syncdb
Now that you know about all these you might start the development server. As usual in Django this is done by running
->>> python manage.py runserver
+ .. code-block:: bash
+
+ $ python manage.py runserver
within the Django Site Directory - as usual the default address is localhost:8000
Of course it will only be able to start once our app is in place as well.
@@ -153,10 +176,15 @@
------------------
First get the files, and make sure you paste them into your Project directory and adjust it's name to the appropriate configuration you've made earlier in the Django Site. Remeber our default is mailman_django
->>> bzr branch lp:mailmanwebgsoc2011
+ .. code-block:: bash
+
+ $ bzr branch lp:mailmanwebgsoc2011
.. note::
We've tested Revision 172
+
+.. note::
+ We're planning to ease up installation by creating an egg
Test the Sites functionality
----------------------------
@@ -164,7 +192,9 @@
Run the following in the Site Directory
->>> python manage.py test
+ .. code-block:: bash
+
+ $ python manage.py test
.. note::
Please be aware that we want to run a development instance of mailman you need to stop the stable one first and the tests will open it's own mailman temporily.