|
0
|
1 |
*******
|
|
|
2 |
Comt
|
|
|
3 |
*******
|
|
|
4 |
|
|
|
5 |
Presentation
|
|
|
6 |
============
|
|
|
7 |
Comt is the open source version of co-ment, a Web-based text annotation platform.
|
|
|
8 |
|
|
|
9 |
License
|
|
|
10 |
=======
|
|
|
11 |
GNU AFFERO GENERAL PUBLIC LICENSE
|
|
|
12 |
http://www.gnu.org/licenses/agpl.html
|
|
|
13 |
|
|
|
14 |
Dependencies
|
|
|
15 |
============
|
|
|
16 |
|
|
|
17 |
Environment
|
|
|
18 |
-------------
|
|
|
19 |
- Postgresql 8.3 / Mysql 5+ / sqlite
|
|
|
20 |
- Python 2.5+
|
|
|
21 |
- Openoffice 3.0+ & Pandoc
|
|
|
22 |
|
|
|
23 |
|
|
|
24 |
Requirements
|
|
|
25 |
------------
|
|
|
26 |
- python (GPL compatible license)
|
|
|
27 |
- python magic (permissive BSD style license)
|
|
|
28 |
- python setuptools (PSF or ZPL - GPL compatible)
|
|
|
29 |
- python uno (GPL)
|
|
|
30 |
- pandoc
|
|
|
31 |
- headless openoffice
|
|
|
32 |
(all other python dependencies will be downloaded by buildout)
|
|
|
33 |
|
|
|
34 |
Installation (development install)
|
|
|
35 |
============
|
|
|
36 |
1. Install python2.5+ and all required python libraries
|
|
|
37 |
(ubuntu users : 'apt-get install python python-magic python-setuptools python-uno')
|
|
|
38 |
2. Install pandoc
|
|
|
39 |
(ubuntu users : 'apt-get install pandoc')
|
|
|
40 |
3. Install openoffice (headless mode) [used for document conversion]
|
|
|
41 |
(ubuntu users : 'apt-get install sun-java6-jre openoffice.org openoffice.org-headless xvfb)
|
|
|
42 |
4. Install/configure database [skip this step if you plan to use a sqlite database]
|
|
|
43 |
4 a) Postgresql
|
|
|
44 |
- Install and configure database server [skip this step if use an external database server]
|
|
|
45 |
(ubuntu users : 'apt-get install postgresql')
|
|
|
46 |
- Install database client
|
|
|
47 |
(ubuntu users : 'apt-get install postgresql-client')
|
|
|
48 |
- Install python database connector: psycopg2
|
|
|
49 |
(ubuntu users : 'apt-get install python-psycopg2')
|
|
|
50 |
4 b) Mysql
|
|
|
51 |
- Install and configure mysql server [skip this step if use an external database server]
|
|
|
52 |
(ubuntu users : 'apt-get install mysql-server')
|
|
|
53 |
- Install database client
|
|
|
54 |
(ubuntu users : 'apt-get install mysql-client')
|
|
|
55 |
- Install python database connector: mysqldb
|
|
|
56 |
(ubuntu users : 'apt-get install python-mysqldb')
|
|
|
57 |
5. Create a database (we recommend UTF8 encoding) and a read/write access to it. [skip this step if you plan to use a sqlite database]
|
|
|
58 |
The database account accessing the database MUST have administrative privileges when running the 'syncdb command' (step 8)
|
|
|
59 |
(The reason for that is that Postgresql requires such privileges to create the C-based stored procedure that we use for full text indexing)
|
|
|
60 |
7. Setup the project and get dependencies
|
|
|
61 |
- `python bootstrap.py`
|
|
|
62 |
- `./bin/buildout`
|
|
|
63 |
6. Configure Comt to your settings
|
|
|
64 |
- copy settings_local_sample.py to settings_local.py (this file will contain your personal settings)
|
|
|
65 |
- edit settings_local.py to suit your settings (search for 'YOUR_SETTINGS' occurrences, those are mandatory settings)
|
|
|
66 |
7. Create the database structure (and test your database connection)
|
|
|
67 |
- `./bin/django syncdb --settings=settings`
|
|
|
68 |
8. Create basic right management system
|
|
|
69 |
- `./bin/django loaddata roles_generic --settings=settings`
|
|
|
70 |
9. Launch development server
|
|
|
71 |
- `./bin/django manage.py runserver --settings=settings`
|
|
|
72 |
10. Access your Comt instance by pointing your browser to http://127.0.0.1:8000/
|
|
|
73 |
|
|
|
74 |
Installation (production environment)
|
|
|
75 |
=============
|
|
|
76 |
If you'd like to install Comt on a production environment, check out django installation guide at http://www.djangoproject.com/documentation/modpython/
|
|
|
77 |
|
|
|
78 |
Openoffice
|
|
|
79 |
==========
|
|
|
80 |
Comt uses openoffice to convert documents from ODT, MS Word, etc. to html.
|
|
|
81 |
On a development setup, you should make sure no openoffice process is left and launch
|
|
|
82 |
`soffice -headless "-accept=socket,port=2002;urp;"` to start openoffice in background mode.
|
|
|
83 |
|
|
|
84 |
Comt uses
|
|
|
85 |
============
|
|
|
86 |
|
|
|
87 |
Javascript libs used (and license) / shipped with the distribution
|
|
|
88 |
------------------------------------------------------------------
|
|
|
89 |
- Yahoo UI http://developer.yahoo.com/yui/ BSD License
|
|
|
90 |
- JQuery http://jquery.com/ MIT
|
|
|
91 |
- markItUp http://markitup.jaysalvat.com/home/ MIT/GPL
|
|
|
92 |
|
|
|
93 |
Python libraries used (and license) / NOT shipped with the distribution
|
|
|
94 |
-----------------------------------------------------------------------
|
|
|
95 |
- django http://www.djangoproject.com/ BSD License
|
|
|
96 |
- python magic http://hupp.org/adam/hg/python-magic permissive BSD style license
|
|
|
97 |
- Beautiful soup http://www.crummy.com/software/BeautifulSoup/ PSF license
|
|
|
98 |
- python-chardet http://chardet.feedparser.org/ LGPL
|
|
|
99 |
- python-feedparser http://feedparser.org/ "Permissive" custom license
|
|
|
100 |
- python-imaging http://www.pythonware.com/products/pil/ http://www.pythonware.com/products/pil/license.htm
|
|
|
101 |
- python-pytz
|
|
|
102 |
- html5lib
|
|
|
103 |
- python-simplejson
|
|
|
104 |
- python-uno
|
|
|
105 |
- python-utidylib
|
|
|
106 |
- python-yaml
|
|
|
107 |
|
|
|
108 |
Icons
|
|
|
109 |
-----
|
|
|
110 |
- Icons derived from FatCow Icon Set http://www.fatcow.com/free-icons/index.bml (Creative Commons Attribution 3.0 License)
|
|
|
111 |
|
|
|
112 |
FAQ
|
|
|
113 |
====
|
|
|
114 |
Q: I get 'import error' when starting the server (step #9)
|
|
|
115 |
R: Make sure you installed all required python dependencies
|
|
|
116 |
|
|
|
117 |
Community
|
|
|
118 |
=========
|
|
|
119 |
The Comt web site http://www.co-ment.org is the place to ask questions, report bugs, check out the source code or download the releases of Comt.
|
|
|
120 |
|
|
|
121 |
Credits
|
|
|
122 |
========
|
|
|
123 |
We'd like to thank:
|
|
|
124 |
- Kirill Miazine (http://km.krot.org/) for the norwegian translation |