weboob-config

weboob-config is a tool to manage (install, update, configure, etc.) backends.

Usage

This tool can be used to simplify backends management.

For more information about modules, please read this page.

Show available modules

$ weboob-config modules

Show information about a module

$ weboob-config info MODULE

For example:

$ weboob-config info youtube
.------------------------------------------------------------------------------.
| Module youtube                                                               |
+-----------------.------------------------------------------------------------'
| Version         | 201201211619
| Maintainer      | Christophe Benz <christophe.benz@gmail.com>
| License         | AGPLv3+
| Description     | Youtube videos website
| Capabilities    | CapVideo
| Installed       | yes
| Location        | http://updates.weboob.org/0.b/main/youtube.tar.gz
|                 |
| Configuration   | username: Email address (default: )
|                 | password: Password (default: )
'-----------------' 

Add a backend

You can create a backend from a module with:

$ weboob-config add MODULE [PARAMETERS]

For example:

$ weboob-config add youtube
Module "youtube" is available but not installed.
=== [ 30%] Module is not installed yet
=== [ 20%] Downloading module...
=== [ 50%] Checking module authenticity...
=== [ 70%] Setting up module...
=== [ 90%] Downloading icon...
=== [100%] Module youtube has been installed!

Configuration of backend youtube
--------------------------------
[username] Email address: roger.philibert@gmail.com
[password] Password (hidden input):
--------------------------------
Backend "youtube" successfully added.

Note: as the youtube module wasn’t installed, it has been downloaded.

You can also provide parameters on the command-line to prevent the interactive questions.

Show backends

$ weboob-config list
+---------+---------+------------------------------------------------------+
|   Name  |  Module |        Configuration                                 |
+---------+---------+------------------------------------------------------+
| hsbc    | hsbc    | login=61651, password=*****                          |
| youtube | youtube | username=roger.philibert@gmail.com, password=*****   |
+---------+---------+------------------------------------------------------+

Remove a backend

$ weboob-config remove BACKEND

For example:

$ weboob-config remove dlfp_moules

Register a new account

Some modules support the CapAccount capability and allow you to register a new account on their supported website. You can use weboob-config to create a new account:

$ weboob-config register MODULE

Then, it asks you some questions about the account to create, and finally prompts you to create a backend for this new account.