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

4
5
Using the packages provided by your distribution is recommended.
See http://weboob.org/install for a list of available packages.
Christophe Benz's avatar
Christophe Benz committed
6

7
8
Since there are many dependencies, when you install from sources,
you have to handle them by hand, according to your distribution.
Christophe Benz's avatar
Christophe Benz committed
9

10
The requirements are provided in ``setup.py``, except for:
Christophe Benz's avatar
Christophe Benz committed
11

12
* gpgv (for secure updates). If not packaged alone, it should be in ``gnupg`` or ``gpg``.
hydrargyrum's avatar
hydrargyrum committed
13
* PyQt5 (python-pyqt5, pyqt5-dev-tools, python-pyqt5.qtmultimedia) for graphical applications.
14
* For more performance, ensure you have ``libyaml`` and ``simplejson`` installed.
Christophe Benz's avatar
Christophe Benz committed
15

16
Some modules may have more dependencies.
Christophe Benz's avatar
Christophe Benz committed
17

Romain Bignon's avatar
Romain Bignon committed
18
19
20
All installation procedures allow you to chose whether you want graphical
applications.  Add ``--no-qt --no-xdg`` to disable them; ``--qt --xdg`` to
enable them.
Christophe Benz's avatar
Christophe Benz committed
21

Romain Bignon's avatar
Romain Bignon committed
22
23
After a package or system installation, you should run ``weboob-config update``
as your login user.
Christophe Benz's avatar
Christophe Benz committed
24

25
26
User installation
-----------------
Christophe Benz's avatar
Christophe Benz committed
27

28
There is a way to install weboob locally without messing with your system.
Laurent Bachelier's avatar
Laurent Bachelier committed
29
Run ``./tools/local_install.sh`` as your local user. ::
Christophe Benz's avatar
Christophe Benz committed
30

31
    $ ./tools/local_install.sh ~/bin
Christophe Benz's avatar
Christophe Benz committed
32

33
The scripts are copied to ``~/bin``.
Christophe Benz's avatar
Christophe Benz committed
34

Romain Bignon's avatar
Romain Bignon committed
35
36
System installation (discouraged)
---------------------------------
Christophe Benz's avatar
Christophe Benz committed
37

Romain Bignon's avatar
Romain Bignon committed
38
39
40
The install mode copies files to the Python system-wide packages directory (for
example ``/usr/lib/python2.5/site-packages`` for Python 2.5, or
``/usr/local/lib/python2.6/dist-packages`` for Python 2.6). ::
41
42
43
44
45
46
47

    # ./setup.py install

Scripts are copied to ``/usr/bin``.

Development mode
----------------
Christophe Benz's avatar
Christophe Benz committed
48

Romain Bignon's avatar
Romain Bignon committed
49
50
51
This does not actually install anything, but lets you run Weboob from the
source code, while also using the modules from that source. This is only
recommended if using the git source and not a release. ::
Laurent Bachelier's avatar
Laurent Bachelier committed
52

53
    $ ./tools/local_run.sh APPLICATION COMMANDS
Laurent Bachelier's avatar
Laurent Bachelier committed
54

Romain Bignon's avatar
Romain Bignon committed
55
56
For example, instead of running ``videoob -b youtube search plop``, you would
run::
Laurent Bachelier's avatar
Laurent Bachelier committed
57

58
    $ ./tools/local_run.sh videoob -b youtube search plop
Laurent Bachelier's avatar
Laurent Bachelier committed
59
60
61
62
63
64
65


Bash completion
---------------

To enable bash completion, just source the ``tools/weboob_bash_completion``
file from your ``~/.bashrc`` file.