doc/book/annexes/depends.rst
author Denis Laxalde <denis.laxalde@logilab.fr>
Thu, 21 Mar 2019 14:33:54 +0100
changeset 12530 9d88e1177c35
parent 10491 c67bcee93248
permissions -rw-r--r--
Remove Twisted web server Twisted web server is not used anymore and has been superseded by pyramid many years ago. Furthermore, our usage is not compatible with Python 3. So we drop the "etwist" sub-package. As a consequence, "all-in-one" configuration type gets dropped as it was Twisted-specific. We resurrect it in cubicweb/pyramid/config.py by only keeping options used by the "pyramid". Similarly, we introduce a AllInOneCreateHandler in cubicweb/pyramid/pyramidctl.py that is basically the one that lived in cubicweb/etwist/twctl.py and is used to create the "all-in-one" instance. Added a TODO here about "pyramid.ini" that could be generated at the end of bootstrap() method. In cubicweb/devtools/httptest.py, CubicWebServerTC is now equivalent to CubicWebWsgiTC and the latter is dropped.
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
6212
73565b770559 [doc] fix link to appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5924
diff changeset
     3
.. _InstallDependencies:
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
     4
6212
73565b770559 [doc] fix link to appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5924
diff changeset
     5
Installation dependencies
73565b770559 [doc] fix link to appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5924
diff changeset
     6
=========================
2393
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
9917
a98e60464c26 [book] stop talking about the hg `forest` extension
Julien Cristau <julien.cristau@logilab.fr>
parents: 9916
diff changeset
     9
cloning the mercurial tree, here is the list of tools and libraries you need
2393
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
9916
986797d779ea [book] update sections about dependencies
Julien Cristau <julien.cristau@logilab.fr>
parents: 8491
diff changeset
    18
* docutils - http://docutils.sourceforge.net/ - http://pypi.python.org/pypi/docutils
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
    19
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    20
* 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
    21
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    22
* logilab-common - http://www.logilab.org/project/logilab-common -
9916
986797d779ea [book] update sections about dependencies
Julien Cristau <julien.cristau@logilab.fr>
parents: 8491
diff changeset
    23
  http://pypi.python.org/pypi/logilab-common/
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    24
5924
b218df942dd4 [book] update rql documentation and some erroneous/deprecated examples
Julien Jehannet <julien.jehannet@logilab.fr>
parents: 4316
diff changeset
    25
* logilab-database - http://www.logilab.org/project/logilab-database -
9916
986797d779ea [book] update sections about dependencies
Julien Cristau <julien.cristau@logilab.fr>
parents: 8491
diff changeset
    26
  http://pypi.python.org/pypi/logilab-database/
5924
b218df942dd4 [book] update rql documentation and some erroneous/deprecated examples
Julien Jehannet <julien.jehannet@logilab.fr>
parents: 4316
diff changeset
    27
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    28
* logilab-constraint - http://www.logilab.org/project/logilab-constraint -
9916
986797d779ea [book] update sections about dependencies
Julien Cristau <julien.cristau@logilab.fr>
parents: 8491
diff changeset
    29
  http://pypi.python.org/pypi/constraint/
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    30
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    31
* logilab-mtconverter - http://www.logilab.org/project/logilab-mtconverter -
9916
986797d779ea [book] update sections about dependencies
Julien Cristau <julien.cristau@logilab.fr>
parents: 8491
diff changeset
    32
  http://pypi.python.org/pypi/logilab-mtconverter
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    33
9916
986797d779ea [book] update sections about dependencies
Julien Cristau <julien.cristau@logilab.fr>
parents: 8491
diff changeset
    34
* rql - http://www.logilab.org/project/rql - http://pypi.python.org/pypi/rql
2393
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
* 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
    37
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    38
* indexer - http://www.logilab.org/project/indexer -
9916
986797d779ea [book] update sections about dependencies
Julien Cristau <julien.cristau@logilab.fr>
parents: 8491
diff changeset
    39
  http://pypi.python.org/pypi/indexer
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    40
8491
8c526cc46dc6 [doc] add passlib to list of dependencies
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6212
diff changeset
    41
* passlib - https://code.google.com/p/passlib/ -
8c526cc46dc6 [doc] add passlib to list of dependencies
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6212
diff changeset
    42
  http://pypi.python.org/pypi/passlib
8c526cc46dc6 [doc] add passlib to list of dependencies
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 6212
diff changeset
    43
9916
986797d779ea [book] update sections about dependencies
Julien Cristau <julien.cristau@logilab.fr>
parents: 8491
diff changeset
    44
If you're using a Postgresql database (recommended):
4316
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    45
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
    46
* 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
    47
* plpythonu extension
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    48
6212
73565b770559 [doc] fix link to appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5924
diff changeset
    49
Other optional packages:
4316
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    50
c4d4702ef87f [doc] reformulate dependencies
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3819
diff changeset
    51
* fyzz - http://www.logilab.org/project/fyzz -
9916
986797d779ea [book] update sections about dependencies
Julien Cristau <julien.cristau@logilab.fr>
parents: 8491
diff changeset
    52
  http://pypi.python.org/pypi/fyzz *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
    53
ab9e7bcfc764 [doc] add missing dependencies in annexes. explain more precisely source install.
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 2539
diff changeset
    54
2393
6190852af97f [doc] add list of dependencies in appendix
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
diff changeset
    55
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
    56
eggs, buildouts, etc) will be greatly appreciated.