README.md 1.54 KB
Newer Older
1
2
3
4
Weboob
======


Laurent Bachelier's avatar
Laurent Bachelier committed
5
Weboob is a project which provides a core library, modules and applications.
Christophe Benz's avatar
Christophe Benz committed
6

7
## Overview
Christophe Benz's avatar
Christophe Benz committed
8

Laurent Bachelier's avatar
Laurent Bachelier committed
9
The core library defines capabilities: features common to various websites.
10
11
12
For example, [Youtube](http://www.youtube.com/) and
[Dailymotion](http://www.dailymotion.com/) both provide videos; Weboob defines
the `CapVideo` capability for them.
Laurent Bachelier's avatar
Laurent Bachelier committed
13
14
15
16
17
18
19
20
21
22
23
24
25

Each module interfaces with a website and implements one or many of these
capabilities. Modules can be configured (becoming a "backend"), which means
that the end-user can provide personal information to access the underlying
website, like a login and password.

Applications allow the end-user to work with many modules in parallel,
in a multi-threaded way. For example, one could search a video on
many websites at once. Applications are toolkit-agnostic. They can use GTK+,
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 developers write
Laurent Bachelier's avatar
Laurent Bachelier committed
26
modules and applications.
Christophe Benz's avatar
Christophe Benz committed
27

28
29
30
31
32
33
34
35

## Installation

Installation is described on [the website](http://weboob.org) or in the
[INSTALL](INSTALL) file.

## License

Romain Bignon's avatar
Romain Bignon committed
36
Weboob is written in Python and is distributed under the AGPLv3+ license.
Christophe Benz's avatar
Christophe Benz committed
37

38
39
40
## Documentation

For more information, please go to [the official website](http://weboob.org/).
Christophe Benz's avatar
Christophe Benz committed
41

42
43
Some extra info is available in the [Gitlab
wiki](https://git.weboob.org/weboob/devel/wikis/home).
Christophe Benz's avatar
Christophe Benz committed
44

45
46
If you are a developper and looking for how to write a module or contribute to
Weboob, you can have a look at the [developper documentation](http://dev.weboob.org/).