22 ----------------------------- |
22 ----------------------------- |
23 |
23 |
24 |cubicweb| requires some base elements that must be installed to run |
24 |cubicweb| requires some base elements that must be installed to run |
25 correctly. So, first of all, you must install them : |
25 correctly. So, first of all, you must install them : |
26 |
26 |
27 * python >= 2.5 and < 3 |
27 * python >= 2.5 and < 3 |
28 (`Download Python <http://www.python.org/download/>`_). |
28 (`Download Python <http://www.python.org/download/>`_). |
29 You can also consider the Python(x,y) distribution |
29 You can also consider the Python(x,y) distribution |
30 (`Download Python(x,y) <http://code.google.com/p/pythonxy/wiki/Downloads>`_) |
30 (`Download Python(x,y) <http://code.google.com/p/pythonxy/wiki/Downloads>`_) |
31 as it makes things easier for Windows user by wrapping in a single installer |
31 as it makes things easier for Windows user by wrapping in a single installer |
32 python 2.5 plus numerous useful third-party modules and |
32 python 2.5 plus numerous useful third-party modules and |
33 applications (including Eclipse + pydev, which is an arguably good |
33 applications (including Eclipse + pydev, which is an arguably good |
34 IDE for Python under Windows). |
34 IDE for Python under Windows). |
35 |
35 |
36 * `Twisted <http://twistedmatrix.com/trac/>`_ is an event-driven |
36 * `Twisted <http://twistedmatrix.com/trac/>`_ is an event-driven |
37 networking engine |
37 networking engine |
38 (`Download Twisted <http://twistedmatrix.com/trac/>`_) |
38 (`Download Twisted <http://twistedmatrix.com/trac/>`_) |
39 |
39 |
40 * `lxml <http://codespeak.net/lxml/>`_ library |
40 * `lxml <http://codespeak.net/lxml/>`_ library |
41 (version >=2.2.1) allows working with XML and HTML |
41 (version >=2.2.1) allows working with XML and HTML |
42 (`Download lxml <http://pypi.python.org/pypi/lxml/2.2.1>`_) |
42 (`Download lxml <http://pypi.python.org/pypi/lxml/2.2.1>`_) |
43 |
43 |
44 * `Postgresql 8.4 <http://www.postgresql.org/>`_, |
44 * `Postgresql 8.4 <http://www.postgresql.org/>`_, |
45 an object-relational database system |
45 an object-relational database system |
46 (`Download Postgresql <http://www.enterprisedb.com/products/pgdownload.do#windows>`_) |
46 (`Download Postgresql <http://www.enterprisedb.com/products/pgdownload.do#windows>`_) |
47 and its python drivers |
47 and its python drivers |
48 (`Download psycopg <http://www.stickpeople.com/projects/python/win-psycopg/#Version2>`_) |
48 (`Download psycopg <http://www.stickpeople.com/projects/python/win-psycopg/#Version2>`_) |
49 |
49 |
50 * A recent version of `gettext` |
50 * A recent version of `gettext` |
51 (`Download gettext <http://download.logilab.org/pub/gettext/gettext-0.17-win32-setup.exe>`_). |
51 (`Download gettext <http://download.logilab.org/pub/gettext/gettext-0.17-win32-setup.exe>`_). |
52 |
52 |
53 * `rql <http://www.logilab.org/project/rql>`_, |
53 * `rql <http://www.logilab.org/project/rql>`_, |
54 the recent version of the Relationship Query Language parser |
54 the recent version of the Relationship Query Language parser |
55 (`Download rql <http://download.logilab.org/pub/rql/rql-0.26.3.win32-py2.5.exe>`_). |
55 (`Download rql <http://download.logilab.org/pub/rql/rql-0.26.3.win32-py2.5.exe>`_). |
56 |
56 |
57 Install optional elements |
57 Install optional elements |
58 ------------------------- |
58 ------------------------- |
59 |
59 |
60 We recommend you to install the following elements. They are not |
60 We recommend you to install the following elements. They are not |
61 mandatory but they activate very interesting features in |cubicweb|: |
61 mandatory but they activate very interesting features in |cubicweb|: |
62 |
62 |
63 * `Simplejson <http://pypi.python.org/pypi/simplejson/>`_ |
63 * `Simplejson <http://pypi.python.org/pypi/simplejson/>`_ |
64 must be installed if you have python <= 2.5 |
64 must be installed if you have python <= 2.5 |
65 (`Download simplejson <http://www.osuch.org/python-simplejson%3Awin32>`_). |
65 (`Download simplejson <http://www.osuch.org/python-simplejson%3Awin32>`_). |
66 It is included in the Standard library from Python >= 2.6. |
66 It is included in the Standard library from Python >= 2.6. |
67 |
67 |
68 * `Pyro <http://www.xs4all.nl/~irmen/pyro3/>`_ |
68 * `Pyro <http://www.xs4all.nl/~irmen/pyro3/>`_ |
69 enables remote access to cubicweb repository instances. |
69 enables remote access to cubicweb repository instances. |
70 It also allows the client and the server not running on the same machine |
70 It also allows the client and the server not running on the same machine |
71 (`Download Pyro <http://www.xs4all.nl/~irmen/pyro3/download/>`_). |
71 (`Download Pyro <http://www.xs4all.nl/~irmen/pyro3/download/>`_). |
72 |
72 |
73 * `python-ldap <http://pypi.python.org/pypi/python-ldap>`_ |
73 * `python-ldap <http://pypi.python.org/pypi/python-ldap>`_ |
74 provides access to LDAP/Active directory directories |
74 provides access to LDAP/Active directory directories |
75 (`Download python-ldap <http://www.osuch.org/python-ldap>`_). |
75 (`Download python-ldap <http://www.osuch.org/python-ldap>`_). |
76 |
76 |
77 * `graphviz <http://www.graphviz.org/>`_ |
77 * `graphviz <http://www.graphviz.org/>`_ |
78 which allow schema drawings. |
78 which allow schema drawings. |
79 (`Download graphviz <http://www.graphviz.org/Download_windows.php>`_). |
79 (`Download graphviz <http://www.graphviz.org/Download_windows.php>`_). |
80 It is quite recommended (albeit not mandatory). |
80 It is quite recommended (albeit not mandatory). |
81 |
81 |
82 Other elements will activate more features once installed. Take a look |
82 Other elements will activate more features once installed. Take a look |
83 at :ref:`InstallDependencies`. |
83 at :ref:`InstallDependencies`. |
86 ------------ |
86 ------------ |
87 |
87 |
88 Some additional tools could be useful to develop :ref:`cubes <AvailableCubes>` |
88 Some additional tools could be useful to develop :ref:`cubes <AvailableCubes>` |
89 with the framework. |
89 with the framework. |
90 |
90 |
91 * `mercurial <http://mercurial.selenic.com/>`_ and its standard |
91 * `mercurial <http://mercurial.selenic.com/>`_ and its standard windows GUI |
92 windows GUI (`TortoiseHG <http://tortoisehg.bitbucket.org/>`_) |
92 (`TortoiseHG <http://tortoisehg.bitbucket.org/>`_) allow you to get the source |
93 allow you to get the source code of |cubicweb| from control version |
93 code of |cubicweb| from control version repositories. So you will be able to |
94 repositories. So you will be able to get the latest development |
94 get the latest development version and pre-release bugfixes in an easy way |
95 version in an easy way |
|
96 (`Download mercurial <http://bitbucket.org/tortoisehg/stable/wiki/download>`_). |
95 (`Download mercurial <http://bitbucket.org/tortoisehg/stable/wiki/download>`_). |
97 |
96 |
98 * You can also consider the ssh client `Putty` in order to peruse |
97 * You can also consider the ssh client `Putty` in order to peruse |
99 mercurial over ssh (`Download <http://www.putty.org/>`_). |
98 mercurial over ssh (`Download <http://www.putty.org/>`_). |
100 |
99 |
101 * If you are an Eclipse user, mercurial can be integrated using the |
100 * If you are an Eclipse user, mercurial can be integrated using the |
102 `MercurialEclipse` plugin |
101 `MercurialEclipse` plugin |
103 (`Home page <http://www.vectrace.com/mercurialeclipse/>`_). |
102 (`Home page <http://www.vectrace.com/mercurialeclipse/>`_). |
104 |
103 |
105 Getting the sources |
104 Getting the sources |
106 ------------------- |
105 ------------------- |
107 |
106 |
108 There are tow ways to get the sources of |cubicweb| and its |
107 There are tow ways to get the sources of |cubicweb| and its |
109 :ref:`cubes <AvailableCubes>`: |
108 :ref:`cubes <AvailableCubes>`: |
110 |
109 |
111 * download the latest release (:ref:`SourceInstallation`) |
110 * download the latest release (:ref:`SourceInstallation`) |
112 * get the development version using Mercurial |
111 * get the development version using Mercurial |
113 (:ref:`MercurialInstallation`) |
112 (:ref:`MercurialInstallation`) |
114 |
113 |
115 Environment variables |
114 Environment variables |
116 --------------------- |
115 --------------------- |
117 |
116 |