improve INSTALL

This commit is contained in:
Christophe Benz 2010-07-30 17:58:46 +02:00
commit f8418a1453

82
INSTALL
View file

@ -1,30 +1,41 @@
Weboob installation Weboob installation
=================== ===================
Like any Python package using setuptools, Weboob can be installed in normal or Like any Python package using setuptools, Weboob can be installed:
development mode. * from eggs
* from Debian packages
* from setup.py in install mode or in development mode
Weboob is distributed with many packages. There is one package for the core
From Eggs
---------
Weboob is distributed using many packages. There is one package for the core
library, many packages for backends (grouped by capabilities), and one package library, many packages for backends (grouped by capabilities), and one package
for each application. for each application.
To install:
Eggs install TODO: no packages released for the moment
------------
Call the helper script which will build the packages and install them all:
# ./tools/all_packages.sh install
To uninstall: To uninstall:
* remove the Weboob eggs: TODO: no packages released for the moment
# rm -rf /usr/lib/python2.5/site-packages/weboob_*.egg
* remove the weboob lines in
/usr/lib/python2.5/site-packages/easy-install.pth
Development mode From Debian packages
---------------- --------------------
Install from the Weboob repository:
TODO: no Debian repository exists
For developers: build yourself Debian packages using
$ ./tools/packaging/create_debian_packages.sh
From setup.py
-------------
The install mode copies files to /usr/lib/python2.5/site-packages
or /usr/local/lib/python2.6/dist-packages
The development mode doesn't copy files, but it creates an egg-link The development mode doesn't copy files, but it creates an egg-link
which points to the development directory. which points to the development directory.
@ -32,41 +43,18 @@ It is useful for development when files often change.
# ./setup.py develop # ./setup.py develop
Creates /usr/lib/python2.5/site-packages/weboob_dev.egg-link Creates /usr/lib/python2.5/site-packages/weboob_dev.egg-link
or /usr/local/lib/python2.6/dist-packages/weboob_dev.egg-link
Scripts are not copied to /usr/bin, so you must launch them with: If you don't want to install all the dependencies, use the --no-deps option:
$ ./scripts/videoob (for example)
To uninstall, remove this egg-link and remove the weboob_dev line in
/usr/lib/python2.5/site-packages/easy-install.pth
Debian note
-----------
When using Debian, it is advised to install Python Debian packages, and not the
PyPI ones (when they are available).
To achieve this, use the --no-deps option of setup.py:
# ./setup.py develop --no-deps # ./setup.py develop --no-deps
and install dependencies by hand from your distribution packages, or from PyPI
using easy_install, or the more modern pip.
Then, please install the following packages before installing Weboob: Scripts are copied to /usr/bin.
* pyqt4-dev-tools
* python-dateutil
* python-feedparser
* python-gdata
* python-html5lib
* python-imaging
* python-lxml
* python-qt4
* python-qt4-phonon
* python-simplejson
* python-yaml
Optional: To uninstall, remove the egg-link and remove the weboob_dev line in
* python-gtk /usr/lib/python2.5/site-packages/easy-install.pth
* python-webkit or /usr/local/lib/python2.6/dist-packages/easy-install.pth
* python-imaging
* python-webob
Bash completion Bash completion