INSTALL 2.79 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 13
* gpgv (for secure updates). If not packaged alone, it should be in ``gnupg`` or ``gpg``.
* For more performance, ensure you have ``libyaml`` and ``simplejson`` installed.
14

15
Some modules may have more dependencies.
16

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

Vincent A's avatar
Vincent A committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
There are 2 versions of weboob:

* stable: for end-users, only modules are updated on this version, not the core or apps
* master: for development, modules and core libs and apps are updated frequently

End-user installation (stable version)
--------------------------------------

No need to use the git repository in this case. Just

    $ pip install --user weboob

This pip installation can be run within a virtualenv if desired (don't add ``--user``).

Then `weboob-config update` can be run to fetch the list of available modules,
and the various weboob commands (boobank, videoob, etc.) can be run and are able
to install modules.

Developer installation (master version)
---------------------------------------

There is a way to install weboob locally without messing with your system.

    $ pip install --user -e .

The scripts are copied to ``~/.local/bin``.

This pip installation can be run within a virtualenv if desired (don't add ``--user``).

Developer installation (master version, alternative)
----------------------------------------------------
Christophe Benz's avatar
Christophe Benz committed
51

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

55
    $ ./tools/local_install.sh ~/bin
Christophe Benz's avatar
Christophe Benz committed
56

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

Romain Bignon's avatar
Romain Bignon committed
59 60
System installation (discouraged)
---------------------------------
Christophe Benz's avatar
Christophe Benz committed
61

Romain Bignon's avatar
Romain Bignon committed
62
The install mode copies files to the Python system-wide packages directory (for
63
example ``/usr/lib/python3.7/dist-packages`` for Python 3.7. ::
64

Vincent A's avatar
Vincent A committed
65
    # pip install --system .
66 67 68

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

Vincent A's avatar
Vincent A committed
69 70
No installation mode (master version)
-------------------------------------
Christophe Benz's avatar
Christophe Benz committed
71

Romain Bignon's avatar
Romain Bignon committed
72 73 74
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. ::
75

76
    $ ./tools/local_run.sh APPLICATION COMMANDS
77

Romain Bignon's avatar
Romain Bignon committed
78 79
For example, instead of running ``videoob -b youtube search plop``, you would
run::
80

81
    $ ./tools/local_run.sh videoob -b youtube search plop
82 83 84 85 86 87

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

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