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

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

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

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

* gpgv (for secure updates). If not packaged alone, it should be in ``gnupg`` or ``gpg``.
hydrargyrum's avatar
hydrargyrum committed
* PyQt5 (python-pyqt5, pyqt5-dev-tools, python-pyqt5.qtmultimedia) for graphical applications.
* For more performance, ensure you have ``libyaml`` and ``simplejson`` installed.
Some modules may have more dependencies.
Romain Bignon's avatar
Romain Bignon committed
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

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

User installation
-----------------
Christophe Benz's avatar
Christophe Benz committed

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

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

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

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

Romain Bignon's avatar
Romain Bignon committed
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). ::

    # ./setup.py install

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

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

Romain Bignon's avatar
Romain Bignon committed
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. ::
    $ ./tools/local_run.sh APPLICATION COMMANDS
Romain Bignon's avatar
Romain Bignon committed
For example, instead of running ``videoob -b youtube search plop``, you would
run::
    $ ./tools/local_run.sh videoob -b youtube search plop
Laurent Bachelier's avatar
Laurent Bachelier committed


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

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