Installation

Pip

This package is supported by the woob Team.

There is an official package.

# pip install woob

Sources

Release tarballs

Get the latest tarball on the Releases page

Git

Stable branch

The stable branch is the latest release of woob with additional fixes.

$ git clone https://gitlab.com/woob/woob.git -b stable

Development branch

To get the latest features or to contribute to woob.

$ git clone https://gitlab.com/woob/woob.git

Installation instructions

Since there are many dependencies, when you install from sources, you have to handle them by hand, according to your distribution.

The requirements are provided in setup.py, except for:

  • python-termcolor, for colors in some console applications.
  • gpgv (for secure updates). If not packaged alone, it should be in gnupg or gpg.
  • PyQt5 (python-qt5) for graphical applications.
  • For more performance, ensure you have libyaml and simplejson installed.

Some modules may have more dependencies.

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.

User installation

There is a way to install woob locally without messing with your system. Run ./tools/local_install.sh as your local user.

$ ./tools/local_install.sh ~/bin

The scripts are copied to ~/bin.

System installation (discouraged)

The install mode copies files to the Python system-wide packages directory (for example /usr/local/lib/python2.7/dist-packages for Python 2.7).

# ./setup.py install

Scripts are copied to /usr/bin.

Development mode

If you are a developper, you could have a look to the development environment