README.md 1.52 KB
Newer Older
1
2
Woob
====
3
4


5
Woob 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
For example, [Youtube](http://www.youtube.com/) and
11
[Dailymotion](http://www.dailymotion.com/) both provide videos; Woob defines
12
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

## Installation

Romain Bignon's avatar
Romain Bignon committed
31
Installation is described on [the website](https://woob.tech) or in the
32
33
34
35
[INSTALL](INSTALL) file.

## License

36
Woob is written in Python and is distributed under the LGPLv3+ license.
Christophe Benz's avatar
Christophe Benz committed
37

38
39
## Documentation

Romain Bignon's avatar
Romain Bignon committed
40
For more information, please go to [the official website](https://woob.tech/).
Christophe Benz's avatar
Christophe Benz committed
41

42
Some extra info is available in the [Gitlab
Roger Philibert's avatar
Roger Philibert committed
43
wiki](https://gitlab.com/woob/woob/wikis/home).
Christophe Benz's avatar
Christophe Benz committed
44

45
If you are a developper and looking for how to write a module or contribute to
Romain Bignon's avatar
Romain Bignon committed
46
Woob, you can have a look at the [developper documentation](https://dev.woob.tech/).