From e3c45c8b128050a2c3964cfc907266ca8c2d1e24 Mon Sep 17 00:00:00 2001 From: Moritz Schlarb Date: Tue, 16 Oct 2012 00:40:42 +0200 Subject: [PATCH 1/2] Add test suite execution notice --- INSTALL.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/INSTALL.rst b/INSTALL.rst index 076b1bf9..442a338b 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -61,3 +61,11 @@ This can be achieved easily by adding the ``--reload`` option:: Then you are ready to go. You can access your instance of the application by browsing to: http://localhost:8080/ + + +Test suite +^^^^^^^^^^ + +To execute the test suite, simply run:: + + $ nosetests From fc7576faa1fcf96425a4380074a3960f7093c6fd Mon Sep 17 00:00:00 2001 From: Moritz Schlarb Date: Tue, 16 Oct 2012 09:08:02 +0200 Subject: [PATCH 2/2] Update docs --- Changelog | 8 +++++--- INSTALL.rst | 30 +++++++++++++++++++++--------- README.rst | 16 ++++++++-------- setup.py | 2 +- 4 files changed, 35 insertions(+), 21 deletions(-) diff --git a/Changelog b/Changelog index 81a179af..956faaa2 100644 --- a/Changelog +++ b/Changelog @@ -2,9 +2,11 @@ Changelog ========= -Version x -------------- +Version 0.8 and 0.8.1 +--------------------- + - Simplifiy user model +- Rename demo event to ``demo`` Version 0.7.5 ------------- @@ -27,7 +29,7 @@ Version 0.7.3 - Moar test cases - Bootstrap modal popup for deletions - Initial Submission similarity table view -- Better logging facilitys +- Better logging facilities - More robust handling of Runner argv parameters Version 0.7.2 diff --git a/INSTALL.rst b/INSTALL.rst index 442a338b..8acce8a5 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -21,15 +21,27 @@ Installation and Setup Development Setup ^^^^^^^^^^^^^^^^^ -First, if not already installed, install virtualenv:: - - $ easy_install virtualenv - -Then create a virtualenv (a "sandbox" for installing Python packages -without polluting the system ``site-packages``) and source the -``activate`` script to enter the virtualenv:: - - $ virtualenv --no-site-packages tg +To set up a local instance of the SAUCE application, you will need: + +- An UNIX-like operating system +- A Python interpreter (2.6 or 2.7) +- The ``virtualenv`` package for Python + (e.g. called ``python-virtualenv`` in Ubunutu 12.04) +- The Python packages ``numpy`` and ``matplotlib`` have to be + installed system-wide, too. + (e.g. called ``python-numpy`` and ``python-matplotlib`` in + Ubunutu 12.04) + +No further packages have to be installed in the system, everything else +gets installed inside a virtualenv (a "sandbox" for installing Python +packages without polluting the system ``site-packages``). + +Now create such a virtualenv and source the ``activate`` script to +enter it (the option ``--system-site-packages`` is important to +make the ``numpy`` and ``matplotlib`` packages available inside the +virtualenv):: + + $ virtualenv --system-site-packages tg $ cd tg $ . bin/activate diff --git a/README.rst b/README.rst index 11f25068..a1d93a02 100644 --- a/README.rst +++ b/README.rst @@ -26,8 +26,8 @@ If you want to try out SAUCE without setting up your own instance, you can access the demo instance at http://demo1-sauce.rhcloud.com/ . Every newly set up instance has some dummy data which includes several -users and a sample event called **eip12**: -http://demo1-sauce.rhcloud.com/events/eip12 +users and a sample event called **demo**: +http://demo1-sauce.rhcloud.com/events/demo You can `log in `_ for different user roles using the following credentials: @@ -36,19 +36,19 @@ for different user roles using the following credentials: | Role | Username | Password | What's special to see with this role? | +====================+================+=================+===================================================================+ | Master teacher | ``teacher`` | ``teachpass`` | The event administration page at | -| (responsible for | | | http://demo1-sauce.rhcloud.com/events/eip12/admin | -| event **eip12**) | | | and the lesson submission page at | -| | | | http://demo1-sauce.rhcloud.com/events/eip12/lessons/2/submissions | +| (responsible for | | | http://demo1-sauce.rhcloud.com/events/demo/admin | +| event **demo**) | | | and the lesson submission page at | +| | | | http://demo1-sauce.rhcloud.com/events/demo/lessons/2/submissions | | | | | and the judgement pages for the submissions. | +--------------------+----------------+-----------------+-------------------------------------------------------------------+ | Tutor | ``tutor`` | ``tutorpass`` | The lesson submission page at | -| (responsible for | | | http://demo1-sauce.rhcloud.com/events/eip12/lessons/1/submissions | +| (responsible for | | | http://demo1-sauce.rhcloud.com/events/demo/lessons/1/submissions | | lesson 1 of event | | | and the judgement pages for the submissions. | -| **eip12**) | | | Also, the similarity page for an assignment | +| **demo**) | | | Also, the similarity page for an assignment | | | | | would be very interesting. | +--------------------+----------------+-----------------+-------------------------------------------------------------------+ | Various students | ``studenta1``, | ``studentpass`` | The user profile page, where you can see your own | -| of event **eip12** | ``studenta2``, | | and your team member's submissions at | +| of event **demo** | ``studenta2``, | | and your team member's submissions at | | | ``studentb1``, | | http://demo1-sauce.rhcloud.com/user | | | ``studentc1``, | | | | | ``studentc2`` | | | diff --git a/setup.py b/setup.py index 95d3e71d..394f14cb 100644 --- a/setup.py +++ b/setup.py @@ -74,7 +74,7 @@ setup( name='SAUCE', - version='0.8', + version='0.8.1', description='System for AUtomated Code Evaluation', long_description=open('README.rst').read(), author='Moritz Schlarb',