Skip to content
README.md 1.54 KiB
Newer Older
Romain Bignon's avatar
Romain Bignon committed
Weboob
======


Romain Bignon's avatar
Romain Bignon committed
Weboob is a project which provides a core library, modules and applications.

Romain Bignon's avatar
Romain Bignon committed
## Overview
Romain Bignon's avatar
Romain Bignon committed

The core library defines capabilities: features common to various websites.
Romain Bignon's avatar
Romain Bignon committed
For example, [Youtube](http://www.youtube.com/) and
[Dailymotion](http://www.dailymotion.com/) both provide videos; Weboob defines
the `CapVideo` capability for them.
Romain Bignon's avatar
Romain Bignon committed

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
modules and applications.

Romain Bignon's avatar
Romain Bignon committed

## Installation

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

## License

Romain Bignon's avatar
Romain Bignon committed
Weboob is written in Python and is distributed under the LGPLv3+ license.
Romain Bignon's avatar
Romain Bignon committed

Romain Bignon's avatar
Romain Bignon committed
## Documentation

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

Romain Bignon's avatar
Romain Bignon committed
Some extra info is available in the [Gitlab
wiki](https://git.weboob.org/weboob/devel/wikis/home).
Romain Bignon's avatar
Romain Bignon committed

Romain Bignon's avatar
Romain Bignon committed
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/).