Installation
Gentoo
This package is supported by the woob Team.
There is an official package.
# emerge -av --autounmask-write weboob
Nix and NixOS
Nixpkgs is a collection of packages that can be used with the Nix package manager on various Unix-like systems. It is also used by the NixOS Linux distibution.
This package has been checked by the woob team.
There is an official package in Nixpkgs.
nix-env -iA pythonPackages.weboob
To try out Weboob without modifying your system, do:
nix-shell -p pythonPackages.weboob
Arch Linux
This package has been checked by the woob team.
A package is available in the AUR, and it is usually updated quickly.
A development package is also available.
Mandriva
These instructions might not be up to date.
Instructions in French: http://wiki.mandriva.com/fr/Weboob
Mac OSX
An Homebrew Formula is available (version 1.2):
# brew install weboob
From sources
If you want to install weboob from source, the simplest is to use pipsi (see below). If you do not have access to pipsi, you can use python-virtualenv manually as we demonstrate now.
With python-virtualenv
You first have to install python-virtualenv. It is commonly available so you might have it already or can install it easily (not described here). When you have python-virtualenv, execute the following:
$ mkdir -p ~/.local/venvs $ virtualenv ~/.local/venvs/woob $ source ~/.local/venvs/woob/bin/activate (woob) $ pip install git+https://gitlab.com/woob/woob.git (woob) $ pip install pdfminer # add other optional dependencies if you want (woob) $ woob config update (woob) $ deactivate $
Then, each time you want to use woob, do this:
$ ~/.local/venvs/woob/bin/boobank # or any other woob command
You can add ~/.local/venvs/woob/bin
to your PATH
to facilitate
access to woob executable files.
With pipsi
pipsi takes care of creating virtual environments, installing a package inside, and doing symbolic links to facilitate usage of package executable files. If you have pipsi, you just have to do this:
$ pipsi install git+https://gitlab.com/woob/woob.git/#egg=woob $ ~/.local/venvs/woob/bin/woob config update $ source ~/.local/venvs/woob/bin/activate (woob) $ pip install pdfminer # add other optional dependencies (woob) $ deactivate $
At this point, every woob executable file is now in
~/.local/bin
. Add this directory to your PATH
environment variable
if it is not there already.
Below we discuss other scenarios to install woob.
Simple pip user install
pip install --user woob
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
orgpg
. - PyQt5 (python-qt5) for graphical applications.
- For more performance, ensure you have
libyaml
andsimplejson
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