doc/book/en/annexes/depends.rst
author Julien Jehannet <julien.jehannet@logilab.fr>
Wed, 07 Jul 2010 10:53:03 +0200
changeset 5924 b218df942dd4
parent 4316 c4d4702ef87f
child 6212 73565b770559
permissions -rw-r--r--
[book] update rql documentation and some erroneous/deprecated examples
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     1
.. -*- coding: utf-8 -*-
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     2
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     3
.. _dependencies:
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     4
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     5
Dependencies
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     6
============
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     7
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     8
When you run CubicWeb from source, either by downloading the tarball or
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     9
cloning the mercurial forest, here is the list of tools and libraries you need
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    10
to have installed in order for CubicWeb to work:
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    11
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    12
* yapps - http://theory.stanford.edu/~amitp/yapps/ -
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    13
  http://pypi.python.org/pypi/Yapps2
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    14
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    15
* pygraphviz - http://networkx.lanl.gov/pygraphviz/ -
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    16
  http://pypi.python.org/pypi/pygraphviz
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    17
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    18
* simplejson - http://code.google.com/p/simplejson/ -
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    19
  http://pypi.python.org/pypi/simplejson
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    20
3819
7591b89ada23 no more dependency on mx date time. Better description of optional dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3488
diff changeset
    21
* docsutils - http://docutils.sourceforge.net/ - http://pypi.python.org/pypi/docutils
7591b89ada23 no more dependency on mx date time. Better description of optional dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3488
diff changeset
    22
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    23
* lxml - http://codespeak.net/lxml - http://pypi.python.org/pypi/lxml
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    24
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    25
* twisted - http://twistedmatrix.com/ - http://pypi.python.org/pypi/Twisted
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    26
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    27
* logilab-common - http://www.logilab.org/project/logilab-common -
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    28
  http://pypi.python.org/pypi/logilab-common/ - included in the forest
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    29
5924
b218df942dd4 [book] update rql documentation and some erroneous/deprecated examples
Julien Jehannet <julien.jehannet@logilab.fr>
parents: 4316
diff changeset
    30
* logilab-database - http://www.logilab.org/project/logilab-database -
b218df942dd4 [book] update rql documentation and some erroneous/deprecated examples
Julien Jehannet <julien.jehannet@logilab.fr>
parents: 4316
diff changeset
    31
  http://pypi.python.org/pypi/logilab-database/ - included in the forest
b218df942dd4 [book] update rql documentation and some erroneous/deprecated examples
Julien Jehannet <julien.jehannet@logilab.fr>
parents: 4316
diff changeset
    32
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    33
* logilab-constraint - http://www.logilab.org/project/logilab-constraint -
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    34
  http://pypi.python.org/pypi/constraint/ - included in the forest
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    35
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    36
* logilab-mtconverter - http://www.logilab.org/project/logilab-mtconverter -
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    37
  http://pypi.python.org/pypi/logilab-mtconverter - included in the forest
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    38
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    39
* rql - http://www.logilab.org/project/rql - http://pypi.python.org/pypi/rql -
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    40
  included in the forest
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    41
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    42
* yams - http://www.logilab.org/project/yams - http://pypi.python.org/pypi/yams
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    43
  - included in the forest
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    44
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    45
* indexer - http://www.logilab.org/project/indexer -
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    46
  http://pypi.python.org/pypi/indexer - included in the forest
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    47
3819
7591b89ada23 no more dependency on mx date time. Better description of optional dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3488
diff changeset
    48
To use network communication between cubicweb instances / clients:
3488
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2539
diff changeset
    49
5924
b218df942dd4 [book] update rql documentation and some erroneous/deprecated examples
Julien Jehannet <julien.jehannet@logilab.fr>
parents: 4316
diff changeset
    50
* Pyro - http://www.xs4all.nl/~irmen/pyro3/ - http://pypi.python.org/pypi/Pyro
3819
7591b89ada23 no more dependency on mx date time. Better description of optional dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3488
diff changeset
    51
7591b89ada23 no more dependency on mx date time. Better description of optional dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3488
diff changeset
    52
If you're using a Postgres database (recommended):
4316
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    53
3819
7591b89ada23 no more dependency on mx date time. Better description of optional dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3488
diff changeset
    54
* psycopg2 - http://initd.org/projects/psycopg2 - http://pypi.python.org/pypi/psycopg2
4316
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    55
* plpythonu extension
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    56
* tsearch2 extension (for postgres < 8.3, in postgres-contrib)
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    57
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    58
Other optional packages :
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    59
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    60
:
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    61
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    62
* fyzz - http://www.logilab.org/project/fyzz -
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    63
  http://pypi.python.org/pypi/fyzz - included in the forest, *to activate Sparql querying*
3488
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2539
diff changeset
    64
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2539
diff changeset
    65
For the google-appengine extension to be available, you also need:
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2539
diff changeset
    66
4316
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    67
* vobject - http://vobject.skyhouseconsulting.com/ -
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    68
  http://pypi.python.org/pypi/vobject, *for the icalendar view*. For those not
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    69
  benefiting from a packaging system, note that vobject itself depends on
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    70
  dateutil - http://labix.org/python-dateutil -
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    71
  http://pypi.python.org/pypi/python-dateutil/.
3488
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2539
diff changeset
    72
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2539
diff changeset
    73
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    74
Any help with the packaging of CubicWeb for more than Debian/Ubuntu (including
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    75
eggs, buildouts, etc) will be greatly appreciated.