Skip to content
INSTALL 1.77 KiB
Newer Older
Christophe Benz's avatar
Christophe Benz committed
Weboob installation
===================

Christophe Benz's avatar
Christophe Benz committed
Like any Python package using setuptools, Weboob can be installed:
 * from eggs
 * from Debian packages
 * from setup.py in install mode or in development mode
Christophe Benz's avatar
Christophe Benz committed

Christophe Benz's avatar
Christophe Benz committed

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
for each application.
Christophe Benz's avatar
Christophe Benz committed
To install:
TODO: no packages released for the moment
Christophe Benz's avatar
Christophe Benz committed
To uninstall:
TODO: no packages released for the moment
Christophe Benz's avatar
Christophe Benz committed

Christophe Benz's avatar
Christophe Benz committed
From Debian packages
--------------------
Christophe Benz's avatar
Christophe Benz committed

Christophe Benz's avatar
Christophe Benz committed
Install from the Weboob repository:
TODO: no Debian repository exists

For developers: build yourself Debian packages using
$ ./tools/packaging/create_debian_packages.sh
Christophe Benz's avatar
Christophe Benz committed
From setup.py
-------------

The install mode copies files to /usr/lib/python2.5/site-packages
or /usr/local/lib/python2.6/dist-packages
Christophe Benz's avatar
Christophe Benz committed

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
Creates /usr/lib/python2.5/site-packages/weboob_dev.egg-link
Christophe Benz's avatar
Christophe Benz committed
or /usr/local/lib/python2.6/dist-packages/weboob_dev.egg-link
Christophe Benz's avatar
Christophe Benz committed
If you don't want to install all the dependencies, use the --no-deps option:
# ./setup.py develop --no-deps
Christophe Benz's avatar
Christophe Benz committed
and install dependencies by hand from your distribution packages, or from PyPI
using easy_install, or the more modern pip.

Scripts are copied to /usr/bin.
Christophe Benz's avatar
Christophe Benz committed
To uninstall, remove the egg-link and remove the weboob_dev line in
/usr/lib/python2.5/site-packages/easy-install.pth
or /usr/local/lib/python2.6/dist-packages/easy-install.pth
Bash completion
---------------

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