catsoop 18.0.1

\
/    /\__/\
\__=(  o_O )=
(__________)
 |_ |_ |_ |_

CAT-SOOP


CAT-SOOP is a flexible, programmable learning management system originally
developed primarily for use in MIT's 6.01 (Introduction to Electrical
Engineering and Computer Science via Robotics).

CAT-SOOP is Free/Libre Software, available under the terms of the GNU Affero
General Public License, version 3+.  Please note that the terms of this license
apply to the CAT-SOOP system itself, but not to any course material hosted on a
CAT-SOOP instance, unless explicitly stated otherwise.


CONTACT
-------

Web Site: https://catsoop.mit.edu

Community Forum: https://catsoop.mit.edu/forum
                 (post via e-mail: community@catsoop.mit.edu)


INSTALLING
-----------

To install, run:
  $ pip3 install catsoop

Or, for the LTS release, run:
  $ pip3 install catsoop~=2019.9

Or, from a clone of the repository, run:
  $ make install

To generate a config.py file, run:
  $ catsoop configure

If you are setting up a public-facing copy of CAT-SOOP (as opposed to a local
copy for debugging purposes), see the instructions at:
    https://catsoop.mit.edu/website/docs/installing/server_configuration

To start the server, run:
  $ catsoop start

To run all the unit tests:
  $ make test


HACKING
--------

See https://catsoop.mit.edu/website/docs/contributing/hacking


INCLUDED SOFTWARE
-----------------

CAT-SOOP incorporates pieces of third-party software.  Licensing information
for the original programs is available in the LICENSE.included_software file.
The CAT-SOOP distribution also includes several pieces of third-party software.
Licensing information for these programs is included in this distribution, in
the LICENSE.bundled_software file.