setup.rst 8.12 KB
Newer Older
1
.. -*- coding: utf-8 -*-
Adrien Di Mascio's avatar
Adrien Di Mascio committed
2

Sandrine Ribeau's avatar
Sandrine Ribeau committed
3
.. _SetUpEnv:
Adrien Di Mascio's avatar
Adrien Di Mascio committed
4

5
6
Installation of a *CubicWeb* environment
========================================
Adrien Di Mascio's avatar
Adrien Di Mascio committed
7

Nicolas Chauvat's avatar
Nicolas Chauvat committed
8
9
10
11
12
13
Official releases are available from the `CubicWeb.org forge`_ and from
`PyPI`_. Since CubicWeb is developed using `Agile software development
<http://en.wikipedia.org/wiki/Agile_software_development>`_ techniques, releases
happen frequently. In a version numbered X.Y.Z, X changes after a few years when
the API breaks, Y changes after a few weeks when features are added and Z
changes after a few days when bugs are fixed.
14

Nicolas Chauvat's avatar
Nicolas Chauvat committed
15
16
Depending on your needs, you will chose a different way to install CubicWeb on
your system:
17

Nicolas Chauvat's avatar
Nicolas Chauvat committed
18
19
20
21
22
23
- `Installation on Debian/Ubuntu`_
- `Installation on Windows`_
- `Installation in a virtualenv`_
- `Installation with pip`_
- `Installation with easy_install`_
- `Installation from tarball`_
24

Nicolas Chauvat's avatar
Nicolas Chauvat committed
25
If you are a power-user and need the very latest features, you will
26

Nicolas Chauvat's avatar
Nicolas Chauvat committed
27
- `Install from version control`_
28

Nicolas Chauvat's avatar
Nicolas Chauvat committed
29
Once the software is installed, move on to :ref:`ConfigEnv` for better control
30
31
32
33
and advanced features of |cubicweb|.

.. _`Installation on Debian/Ubuntu`: DebianInstallation_
.. _`Installation on Windows`: WindowsInstallation_
Nicolas Chauvat's avatar
Nicolas Chauvat committed
34
.. _`Installation in a virtualenv`: VirtualenvInstallation_
35
36
37
.. _`Installation with pip`: PipInstallation_
.. _`Installation with easy_install`: EasyInstallInstallation_
.. _`Installation from tarball`: TarballInstallation_
Nicolas Chauvat's avatar
Nicolas Chauvat committed
38
.. _`Install from version control`: MercurialInstallation_
39

40

41
42
.. _DebianInstallation:

43
44
45
46
Debian/Ubuntu install
---------------------

|cubicweb| is packaged for Debian/Ubuntu (and derived
Nicolas Chauvat's avatar
Nicolas Chauvat committed
47
48
49
distributions). Their integrated package-management system make
installation and upgrade much easier for users since
dependencies (like databases) are automatically installed.
50

51
Depending on the distribution you are using, add the appropriate line to your
52
53
`list of sources` (for example by editing ``/etc/apt/sources.list``), replacing
``<release>`` with e.g. ``wheezy`` or ``trusty``::
54

55
  deb http://download.logilab.org/production/ <release>/
56

57
The repositories are signed with `Logilab's gnupg key`_. You can download
58
and register the key to avoid warnings::
59

60
  wget -O/etc/apt/trusted.gpg.d/logilab.gpg https://www.logilab.fr/logilab-debian-keyring.gpg
61
62

Update your list of packages and perform the installation::
63

Nicolas Chauvat's avatar
Nicolas Chauvat committed
64
  apt-get update
Sylvain Thénault's avatar
Sylvain Thénault committed
65
  apt-get install cubicweb cubicweb-dev
66

67
68
69
``cubicweb`` installs the framework itself, allowing you to create new
instances. ``cubicweb-dev`` installs the development environment
allowing you to develop new cubes.
70

Nicolas Chauvat's avatar
Nicolas Chauvat committed
71
72
73
There is also a wide variety of :ref:`cubes <AvailableCubes>`. You can access a
list of available cubes using ``apt-cache search cubicweb`` or at the
`CubicWeb.org forge`_.
74

75
76
.. note::

77
  `cubicweb-dev` will install basic sqlite support. You can easily setup
Nicolas Chauvat's avatar
Nicolas Chauvat committed
78
79
  :ref:`cubicweb with other database <DatabaseInstallation>` using the following
  virtual packages :
80

81
  * `cubicweb-postgresql-support` contains the necessary dependencies for
82
    using :ref:`cubicweb with postgresql datatabase <PostgresqlConfiguration>`
83

84
  * `cubicweb-mysql-support` contains the necessary dependencies for using
85
    :ref:`cubicweb with mysql database <MySqlConfiguration>`.
86

87
.. _`list of sources`: http://wiki.debian.org/SourcesList
88
.. _`Logilab's gnupg key`: https://www.logilab.fr/logilab-debian-keyring.gpg
89
90
.. _`CubicWeb.org Forge`: http://www.cubicweb.org/project/

91
.. _WindowsInstallation:
92

93
94
Windows Install
---------------
95

96
You need to have `python`_ version >= 2.5 and < 3 installed.
97

Nicolas Chauvat's avatar
Nicolas Chauvat committed
98
99
100
101
If you want an automated install, your best option is probably the
:ref:`EasyInstallInstallation`. EasyInstall is a tool that helps users to
install python packages along with their dependencies, searching for suitable
pre-compiled binaries on the `The Python Package Index`_.
102

Nicolas Chauvat's avatar
Nicolas Chauvat committed
103
104
105
If you want better control over the process as well as a suitable development
environment or if you are having problems with `easy_install`, read on to
:ref:`SetUpWindowsEnv`.
106

107
108
.. _python:  http://www.python.org/
.. _`The Python Package Index`: http://pypi.python.org
109

110
.. _VirtualenvInstallation:
111

112
113
`Virtualenv` install
--------------------
114

115
116
117
118
|cubicweb| can be safely installed, used and contained inside a
`virtualenv`_. You can use either :ref:`pip <PipInstallation>` or
:ref:`easy_install <EasyInstallInstallation>` to install |cubicweb|
inside an activated virtual environment.
119

120
.. _PipInstallation:
121

122
123
`pip` install
-------------
124

125
126
127
128
`pip <http://pip.openplans.org/>`_ is a python tool that helps downloading,
building, installing, and managing Python packages and their dependencies. It
is fully compatible with `virtualenv`_ and installs the packages from sources
published on the `The Python Package Index`_.
Nicolas Chauvat's avatar
Nicolas Chauvat committed
129
130
131
132

.. _`virtualenv`: http://virtualenv.openplans.org/

A working compilation chain is needed to build the modules that include C
133
extensions. If you really do not want to compile anything, installing `lxml <http://lxml.de/>`_,
Sylvain Thénault's avatar
Sylvain Thénault committed
134
135
`Twisted Web <http://twistedmatrix.com/trac/wiki/Downloads/>`_ and `libgecode
<http://www.gecode.org/>`_ will help.
136

137
138
139
140
141
142
143
144
145
For Debian, these minimal dependencies can be obtained by doing::

  apt-get install gcc python-pip python-dev python-lxml

or, if you prefer to get as much as possible from pip::

  apt-get install gcc python-pip python-dev libxslt1-dev libxml2-dev

For Windows, you can install pre-built packages (possible `source
146
147
148
149
150
151
152
153
154
<http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_). For a minimal setup, install:

- pip http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip
- setuptools http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools
- libxml-python http://www.lfd.uci.edu/~gohlke/pythonlibs/#libxml-python>
- lxml http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml and
- twisted http://www.lfd.uci.edu/~gohlke/pythonlibs/#twisted

Make sure to choose the correct architecture and version of Python.
155
156

Finally, install |cubicweb| and its dependencies, by running::
157

158
159
  pip install cubicweb

Paul Tonelli's avatar
Paul Tonelli committed
160
Many other :ref:`cubes <AvailableCubes>` are available. A list is available at
Nicolas Chauvat's avatar
Nicolas Chauvat committed
161
162
`PyPI <http://pypi.python.org/pypi?%3Aaction=search&term=cubicweb&submit=search>`_
or at the `CubicWeb.org forge`_.
163

164
165
166
For example, installing the *blog cube* is achieved by::

  pip install cubicweb-blog
167
168
169

.. _EasyInstallInstallation:

170
171
`easy_install` install
----------------------
172

Nicolas Chauvat's avatar
Nicolas Chauvat committed
173
174
175
176
.. note::

   If you are not a Windows user and you have a compilation environment, we
   recommend you to use the PipInstallation_.
177

Nicolas Chauvat's avatar
Nicolas Chauvat committed
178
179
180
181
`easy_install`_ is a python utility that helps downloading, installing, and
managing python packages and their dependencies.

Install |cubicweb| and its dependencies, run::
182

183
  easy_install cubicweb
184

Nicolas Chauvat's avatar
Nicolas Chauvat committed
185
186
There is also a wide variety of :ref:`cubes <AvailableCubes>`. You can access a
list of available cubes on `PyPI
187
<http://pypi.python.org/pypi?%3Aaction=search&term=cubicweb&submit=search>`_
Nicolas Chauvat's avatar
Nicolas Chauvat committed
188
or at the `CubicWeb.org Forge`_.
189

190
For example, installing the *blog cube* is achieved by::
191

192
  easy_install cubicweb-blog
193

194
.. note::
195

196
  If you encounter problem with :ref:`cubes <AvailableCubes>` installation,
Nicolas Chauvat's avatar
Nicolas Chauvat committed
197
198
  consider using :ref:`PipInstallation` which is more stable
  but can not installed pre-compiled binaries.
199

Nicolas Chauvat's avatar
Nicolas Chauvat committed
200
.. _`easy_install`: http://packages.python.org/distribute/easy_install.html
201
202
203


.. _SourceInstallation:
204

205
Install from source
206
-------------------
207

208
209
.. _TarballInstallation:

Nicolas Chauvat's avatar
Nicolas Chauvat committed
210
You can download the archive containing the sources from
211
`http://download.logilab.org/pub/cubicweb/ <http://download.logilab.org/pub/cubicweb/>`_.
212

213
Make sure you also have all the :ref:`InstallDependencies`.
214

215
216
217
218
219
220
221
222
223
Once uncompressed, you can install the framework from inside the uncompressed
folder with::

  python setup.py install

Or you can run |cubicweb| directly from the source directory by
setting the :ref:`resource mode <RessourcesConfiguration>` to `user`. This will
ease the development with the framework.

Nicolas Chauvat's avatar
Nicolas Chauvat committed
224
There is also a wide variety of :ref:`cubes <AvailableCubes>`. You can access a
225
list of availble cubes at the `CubicWeb.org Forge`_.
226

227

228
.. _MercurialInstallation:
229

230
Install from version control system
231
-----------------------------------
232

Nicolas Chauvat's avatar
Nicolas Chauvat committed
233
234
To keep-up with on-going development, clone the :ref:`Mercurial
<MercurialPresentation>` repository::
235

236
  hg clone -u 'last(tag())' http://hg.logilab.org/cubicweb # stable version
Nicolas Chauvat's avatar
Nicolas Chauvat committed
237
  hg clone http://hg.logilab.org/cubicweb # development branch
238

Nicolas Chauvat's avatar
Nicolas Chauvat committed
239
Make sure you also have all the :ref:`InstallDependencies`.