INSTALL 1.44 KB
Newer Older
Christophe Benz's avatar
Christophe Benz committed
1
2
3
Weboob installation
===================

4
5
Like any Python package using setuptools, Weboob can be installed in normal or
development mode.
Christophe Benz's avatar
Christophe Benz committed
6

7
8
9
Weboob is distributed with many packages. There is one package for the core
library, many packages for backends (grouped by capabilities), and one package
for each application.
Christophe Benz's avatar
Christophe Benz committed
10
11


12
13
Eggs install
------------
Christophe Benz's avatar
Christophe Benz committed
14

15
Call the helper script which will build the packages and install them all:
Christophe Benz's avatar
Christophe Benz committed
16

17
# ./tools/create_all_packages.sh install
Christophe Benz's avatar
Christophe Benz committed
18

19
20
21
22
23
To uninstall:
* remove the Weboob eggs:
# rm -rf /usr/lib/python2.5/site-packages/weboob_*.egg
* remove the weboob lines in
/usr/lib/python2.5/site-packages/easy-install.pth
Christophe Benz's avatar
Christophe Benz committed
24
25


26
Development mode
Christophe Benz's avatar
Christophe Benz committed
27
28
29
30
31
32
33
----------------

The development mode doesn't copy files, but it creates an egg-link
which points to the development directory.
It is useful for development when files often change.

# ./setup.py develop
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
Creates /usr/lib/python2.5/site-packages/weboob_dev.egg-link

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, please install the following packages before installing Weboob:
* python-gdata

49

50
Bash completion
51
52
53
54
---------------

To enable bash completion, just source the tools/weboob_bash_completion
file from your ~/.bash_completion file (which is sourced by /etc/bash_completion).