nojhan/weboob-devel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Better README/INSTALL

Browse source
This commit is contained in:
Laurent Bachelier 2013-06-26 23:20:52 +02:00
commit dfa28b8420
2 changed files with 25 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

7
INSTALL
View file

@ -56,3 +56,10 @@ For example, instead of running ``videoob -b youtube search plop``, you would
run:: run::
$ ./tools/local_run.sh videoob -b youtube search plop $ ./tools/local_run.sh videoob -b youtube search plop
Bash completion
---------------
To enable bash completion, just source the ``tools/weboob_bash_completion``
file from your ``~/.bashrc`` file.

31
README
View file

@ -3,28 +3,27 @@ Weboob is a project which provides a core library, modules and applications.
Overview Overview
-------- --------
The core library defines capabilities: features common to various websites. For The core library defines capabilities: features common to various websites.
example, http://www.youtube.com and http://www.dailymotion.com are both videos For example, http://www.youtube.com/ and http://www.dailymotion.com/ both
providers: Weboob defines the “ICapVideo” capability. provide videos; Weboob defines the "ICapVideo" capability for them.
Each module interfaces a website and implements one or many of these Each module interfaces with a website and implements one or many of these
capabilities. modules can be configured, which means that the end-user can capabilities. Modules can be configured (becoming a "backend"), which means
provide personal information to access the underlaying website (login/password that the end-user can provide personal information to access the underlying
for example). website, like a login and password.
Applications offer the ability to the end-user to work with many modules in Applications allow the end-user to work with many modules in parallel,
parallel, in a multi-threaded way. For example, one could search a video on in a multi-threaded way. For example, one could search a video on
many providers websites. Applications are toolkit-agnostic. They can use Gtk, many websites at once. Applications are toolkit-agnostic. They can use GTK+,
Qt or text-only, more adapted to reuse data through pipes. Qt or be text-only. The latter can be used either in an interactive way
or in pipes.
The core library provides base classes which help the developer to write The core library provides base classes which help developers write
modules and applications. modules and applications.
Weboob is written in Python and is distributed under the AGPLv3+ license. Weboob is written in Python and is distributed under the AGPLv3+ license.
Bash completion For more information, please go to the official website at http://weboob.org/
---------------
To enable bash completion, just source the tools/weboob_bash_completion Installation is described on the website or in the INSTALL file.
file from your ~/.bash_completion file (which is sourced by /etc/bash_completion).