|
@@ -0,0 +1,38 @@
|
|
|
+The COIN project
|
|
|
+================
|
|
|
+
|
|
|
+`Coin` is Illyse's Information System, designed to managed subscribers.
|
|
|
+
|
|
|
+It is written in Django, and makes an heavy use of LDAP (for
|
|
|
+authentication, and to store configuration information).
|
|
|
+
|
|
|
+It currently only works with python2, because `python-ldap` is (as of
|
|
|
+2013) not compatible with python3.
|
|
|
+
|
|
|
+
|
|
|
+Installation
|
|
|
+============
|
|
|
+
|
|
|
+Get yourself a virtualenv. On Debian, install `python-virtualenv`. On
|
|
|
+Archlinux, the package is called `python2-virtualenv`, and you must
|
|
|
+replace the `virtualenv` command with `virtualenv2` in the following.
|
|
|
+
|
|
|
+To create the virtualenv (the first time):
|
|
|
+
|
|
|
+ virtualenv ~/tmp/venv-illyse
|
|
|
+
|
|
|
+
|
|
|
+To activate the virtualenv (you need to do this each time you work on
|
|
|
+the project):
|
|
|
+
|
|
|
+ . ~/tmp/venv-illyse/bin/activate
|
|
|
+
|
|
|
+
|
|
|
+Install dependencies. On Debian, you will probably need the
|
|
|
+`python-dev`, `libldap-dev` and `libsasl2-dev` packages. Then run:
|
|
|
+
|
|
|
+ pip install -r requirements.txt
|
|
|
+
|
|
|
+
|
|
|
+You should now be able to run `python manage.py` (within the
|
|
|
+virtualenv, obviously) without error.
|