1. Installation of a CubicWeb environment¶
Official releases are available from the CubicWeb.org forge and from PyPI. Since CubicWeb is developed using 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.
Depending on your needs, you will chose a different way to install CubicWeb on your system:
- Installation on Debian/Ubuntu
- Installation on Windows
- Installation in a virtualenv
- Installation with pip
- Installation with easy_install
- Installation from tarball
If you are a power-user and need the very latest features, you will
Once the software is installed, move on to Set-up of a CubicWeb environment for better control and advanced features of CubicWeb.
1.1. Debian/Ubuntu install¶
CubicWeb is packaged for Debian/Ubuntu (and derived distributions). Their integrated package-management system make installation and upgrade much easier for users since dependencies (like databases) are automatically installed.
Depending on the distribution you are using, add the appropriate line to your
list of sources (for example by editing /etc/apt/sources.list
), replacing
<release>
with e.g. wheezy
or trusty
:
deb http://download.logilab.org/production/ <release>/
The repositories are signed with Logilab’s gnupg key. You can download and register the key to avoid warnings:
wget -O/etc/apt/trusted.gpg.d/logilab.gpg https://www.logilab.fr/logilab-debian-keyring.gpg
Update your list of packages and perform the installation:
apt-get update
apt-get install cubicweb cubicweb-dev
cubicweb
installs the framework itself, allowing you to create new
instances. cubicweb-dev
installs the development environment
allowing you to develop new cubes.
There is also a wide variety of cubes. You can access a
list of available cubes using apt-cache search cubicweb
or at the
CubicWeb.org forge.
Note
cubicweb-dev will install basic sqlite support. You can easily setup cubicweb with other database using the following virtual packages :
- cubicweb-postgresql-support contains the necessary dependencies for using cubicweb with postgresql datatabase
- cubicweb-mysql-support contains the necessary dependencies for using cubicweb with mysql database.
1.2. Windows Install¶
You need to have python version >= 2.5 and < 3 installed.
If you want an automated install, your best option is probably the easy_install install. 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.
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 Installing a development environement on Windows.
1.3. Virtualenv install¶
CubicWeb can be safely installed, used and contained inside a virtualenv. You can use either pip or easy_install to install CubicWeb inside an activated virtual environment.
1.4. pip install¶
pip 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.
A working compilation chain is needed to build the modules that include C extensions. If you really do not want to compile anything, installing lxml, Twisted Web and libgecode will help.
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). 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.
Finally, install CubicWeb and its dependencies, by running:
pip install cubicweb
Many other cubes are available. A list is available at PyPI or at the CubicWeb.org forge.
For example, installing the blog cube is achieved by:
pip install cubicweb-blog
1.5. easy_install install¶
Note
If you are not a Windows user and you have a compilation environment, we recommend you to use the PipInstallation.
easy_install is a python utility that helps downloading, installing, and managing python packages and their dependencies.
Install CubicWeb and its dependencies, run:
easy_install cubicweb
There is also a wide variety of cubes. You can access a list of available cubes on PyPI or at the CubicWeb.org Forge.
For example, installing the blog cube is achieved by:
easy_install cubicweb-blog
Note
If you encounter problem with cubes installation, consider using pip install which is more stable but can not installed pre-compiled binaries.
1.6. Install from source¶
You can download the archive containing the sources from http://download.logilab.org/pub/cubicweb/.
Make sure you also have all the Installation dependencies.
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 resource mode to user. This will ease the development with the framework.
There is also a wide variety of cubes. You can access a list of availble cubes at the CubicWeb.org Forge.
1.7. Install from version control system¶
To keep-up with on-going development, clone the Mercurial repository:
hg clone -u 'last(tag())' http://hg.logilab.org/cubicweb # stable version
hg clone http://hg.logilab.org/cubicweb # development branch
Make sure you also have all the Installation dependencies.