cs_content_header = cs_long_name
This page is designed to help you get an instance of CAT-SOOP up and running. If you are setting things up on a local copy, following the instructions on this page should be enough. If you are setting up a public-facing instance on a server you control, you should follow these instructions, and then continue by following the link at the bottom of this page for more information about server configuration.
As a general rule, I only test using Debian GNU/Linux, but others have tested these instructions on Mac OSX and on Windows (Cygwin or LSW).
CAT-SOOP depends on Python (version 3.5+, with pip).
You will need Python version 3.5+ on your system to run CAT-SOOP. Many distributions have Python 3.5+ in their package managers, though it may be necessary to download the source from the official Python site.
On Debian Stretch, you will need the
python3-pip packages (or a
version of Python 3.5+ installed in some other way).
(Cygwin Only) Patch _pyio
As of the time of this writing (December 2017), the Python version available
through Cygwin ships with a broken version of
In order to run CAT-SOOP on a Cygwin host, edit the file
/usr/lib/python3.6/_pyio.py so that the first conditional (about
sys.platform) reads as follows:
if sys.platform == 'win32': from msvcrt import setmode as _setmode elif sys.platform == 'cygwin': import ctypes _cygwin1 = ctypes.PyDLL('cygwin1.dll') def _setmode(fd, mode): return _cygwin1._setmode(ctypes.c_int(fd), ctypes.c_int(mode)) else: _setmode = None
There are several ways you can install CAT-SOOP (as of version 14.0).
Installation via pip
The easiest is pip, with a command like the following:
$ sudo pip3 install catsoop
Alternatively, you can clone the Git repository containing the source code:
git clone https://git.sr.ht/~adqm/catsoop
and then run:
$ sudo python3 setup.py install
from the source directory. You can also run the unit tests by running:
$ sudo python3 setup.py test
To configure CAT-SOOP, run the following command:
and answer the questions it poses.
The default location for CAT-SOOP courses is in
~/.local/share/catsoop/courses/. You should move (or symlink) your courses
to that location.
To start the server, you should run:
$ catsoop runserver
This will start the server listening on port 6010. You should then be able to
directy your browser to
http://localhost:6010 to see the CAT-SOOP instance.
~email@example.com is a place to ask questions about CAT-SOOP usage.
You can view the archives or subscribe
~firstname.lastname@example.org is a low-volume list used to announce
updates to CAT-SOOP. You can view the archives or subscribe
~email@example.com is the place to submit patches, and/or
questions about CAT-SOOP development. Your can view the archives or subscribe
If you are setting up a public-facing CAT-SOOP instance, see also this page about additional server configuration.