[weboob] Weboob's README

Xxxxxxx Xxxxxxx xxxxxxxxxxxxxx at live.fr
Sun May 13 13:39:59 CEST 2012


  Weboob description
  ===================

     Weboob is a collection of applications able to interact with websites, without
     requiring the user to open them in a browser. It also provides well-defined APIs 
     to talk to websites lacking one. Weboob is a project which provides a core library,
     backends and applications.


   Overview
   ========
   
     The core library defines capabilities: features common to various websites. For
     example, http://www.youtube.com and http://www.dailymotion.com are both videos
     providers: Weboob defines the "ICapVideo" capability.
   
     Each backend interfaces a website and implements one or many of these
     capabilities. Backends can be configured, which means that the end-user can
     provide personal information to access the underlaying website (login/password
     for example).
  
     Applications offer the ability to the end-user to work with many backends in
     parallel, in a multi-threaded way. For example, one could search a video on
     many providers websites. Applications are toolkit-agnostic. They can use Gtk,
     Qt or text-only, more adapted to reuse data through pipes.
  
     The core library provides base classes which help the developer to write
     backends and applications.
  
     Weboob is written in Python and is distributed under the AGPLv3+ license.
     
     Dev page: http://symlink.me/projects/weboob/wiki/Development
     Bug report: http://symlink.me/projects/weboob/issues


  Weboob installation
  ===================

     Like any Python package using setuptools, Weboob can be installed in install
     mode or in development mode.


    Install mode
    ------------

     The install mode copies files to the Python system-wide packages directory
     (for example /usr/lib/python2.5/site-packages for Python 2.5,
     or /usr/local/lib/python2.6/dist-packages for Python 2.6)

     # ./setup.py install

     Scripts are copied to /usr/bin.
 
     Since there are many dependencies, when you install from sources,
     you have to handle them by hand, according to your distribution.
     If you still want to download them, you can uncomment the dependencies
     in setup.py

     To uninstall, remove the egg-info from the Python system-wide packages directory
     and remove the weboob_dev line in easy-install.pth.


    Development mode
    ----------------

     The development mode doesn't copy files, but creates an egg-link
     in the Python system-wide packages directory which points to the development
     directory. It is useful for development when files often change.

     # ./setup.py develop

     Scripts are copied to /usr/bin too.

     To uninstall, remove the egg-link from the Python system-wide packages directory
  
    Bash completion
    ---------------
  
     To enable bash completion, just source the tools/weboob_bash_completion
     file from your ~/.bash_completion file (which is sourced by /etc/bash_completion).


    Required packages
    -----------------
 
     python-gdata: http://code.google.com/p/gdata-python-client/
     python-html2text: http://www.aaronsw.com/2002/html2text/
     python-imaging: (Not on SBo): http://www.pythonware.com/products/pil/
     python-mechanize: http://wwwsearch.sourceforge.net/mechanize/
     python-pysqlite (Not on SBo):  http://pypi.python.org/pypi/pysqlite/
     python2-dateutil
     python2-elementtidy
     python2-feedparser
     python2-lxml
     python2-prettytable
     python2-pyqt
     python2-yaml
     which


    Optionnal packages
    -----------------

     Phonon (QVideoob)

   
    Applications 
    ------------

     Weboob is powered by a bunch of applications. Below is a list of what was available
     when this version were released. To check out the last ones, please go here: 
     http://weboob.org/applications/ .


      Graphical applications using the Qt toolkit
      -------------------------------------------    

       * QBoobMsg
           Read and post public and private messages. 

       * QFlatBoob
           Search for housings, bookmark and annotate them. 

       * QHaveDate
           Interact with dating websites, and manage your success. 

       * QVideoob
           Search for videos, get their direct URLs or play them. 

       * QWebContentEdit
           Edit content on supported collaborative websites like wikis. 

       * weboob-config-qt
           Show, install, update and configure backends.



      Textual applications, both command-line and REPL
      ------------------------------------------------

       * Boobank
           List your bank accounts balances, their expenses, transfer money, etc. 

       * Boobill
           List your subscriptions, view and download the bill details. 

       * Boobmsg
           Read and post public and private messages. 

       * Boobooks
           List your books rented and get your booking history. 

       * Boobtracker
           View, edit and create issues on bugtrackers. 

       * Flatboob
           Search for a house. 

       * Geolooc
           Geolocalize IP addresses. 

       * Havedate
           Interact with dating websites, and get popular. 

       * Pastoob
           Submit and get text (source code, backtraces) to pastebin-like websites. 

       * Radioob
           Search for radios, and get direct stream URLs and current playing songs. 

       * Traveloob
           View public transportation timetables. 

       * Videoob
           Search for videos, get their direct URLs, download them or play them. 

       * WebContent
           Edit Manage and edit content on supported collaborative websites like wikis. 

       * weboob-config
           Show, install, update and configure backends. 

       * Weboorrents
           Search for torrents and download the .torrent files. 

       * Wetboobs
           Display current weather water levels and to see forecasts.


      Applications meant to run in background
      ---------------------------------------

       * Monboob
           Receive and reply to messages by mail.


      Maemo (Nokia N900 smartphone)
      -----------------------------

       * Masstransit
           View public transportation timetables.

   Modules 
   =======

     A module is an interface between a website and Weboob. Modules are stored in 
     repositories and can be updated without upgrading Weboob.

     To check if there are new versions of modules, use this command:
      
      $ weboob-config update

     By default, only the default repository is enabled. You can add another one
     by editing the file ~/.config/weboob/sources.list.

     Stay tuned about the new modules:  http://updates.weboob.org/stable/main/rss2.xml

    
    Add a backend
    -------------

     Weboob applications need backends to interact with websites. A backend is a
     configured module, usually with several parameters like your username, password,
     or other options. You can create multiple backends for a single module.

     You can use a console application or a graphical application to edit backends.

    Available modules
    -----------------

     Official list: http://weboob.org/modules . 

    Arte
    AuM 
    Batoto 
    BNPorc
    Boursorama
    Bouygues 
    BP 
    CanalPlus
    CanalTP
    CappedTV
    CMB
    CrAgr
    CreditMutuel
    Dailymotion
    DLFP
    EatManga
    Ecrans
    EHentai
    FourChan
    FranceTelevisions
    FreeMobile
    Gazelle
    GeolocIP
    HdS
    HSBC
    INA
    ING
    Inrocks
    IPInfoDB
    isoHunt
    Izneo
    Kickass
    LCL
    LeFigaro
    MangaFox
    MangaHere
    MangaReader
    MediaWiki
    MeteoFrance
    Minutes20
    Newsfeed
    NolifeTV
    Nova
    Opacwebaloes
    Orange
    OuiFM
    PAP
    Pastealacon
    Pastebin
    phpBB
    PirateBay
    PressEurop
    RadioFrance
    Redmine
    Sachsen
    SeLoger
    SFR
    SimplyReadIt
    SocieteGenerale
    Transilien
    Yahoo
    YouJizz
    YouPorn
    YouTube

_____________________________________________________________________________________

                                 That's all folks!


                     nHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHn.
          .MS?MMMMMMMMMMMMMMMMMM?MM~MMMMMMMMMSHMMMMMMMM(?"~\
          MMMMMH?MMMMMMMX*MM?MMX%MM/MMMMMM"HMMMMMMMMMMMMMMH
         MMMMMMMMMMMMMMMMMX*MX*MMMX?MMMMM(M!XMMMMMMMMMMMMMMMX
        XMC)?MMMMMMMMMMMMMMMhX?!?MMMMX#MM!MXMMMMMMMMMMMML   '~
'\      MMMMMMMMMMMMMMMMMMMMMMMM!~`````-`~!?MMMM)MMMMMMMMx
   `~""MMM)MMMMMMMMMMMMMMMHhHH!~           `#MM(MMMMMMMMMM>
      HM!HMMMMMMMMMMMMMMMM*?)?`                `"MMMMMMMMMX       .
     XM!MMMMMMMMMMMMMMMMMMM?~                     'MMMMMMMM:..xx!`
     M!MMMMMMMMMMMMMMMMMXH!                        MMMMXMMP"`
    \!MMMMMMMSMHHHMM?XMM?~    -:::xx..             M?XMM?".x(
    MXMMMMMMMMMM!XHMMMM":       ... `"%x          XHHHMMM*"
   \!MMMMMMMM?XMMMMMMX!'~L     '%%%+:.  `       ..MMMMM"
   'HMMMMMM?HMMMMM*XM!    h     ~\).^\~     .%""`MM?"
   'MMMMMMMMMMMMMXMMM!    -X               +%%!.MMMXk
   ?MMMMMMMMMMMXMMMMM `.   ~               `""'XMMMMX
   !MMMMMMMMMMMMMMMMMX.    '                  XMkMMX>
   XMMMMMMMMMMMMMMM?MXXXx.-`                  XXMMM!
   MMMMMMMMMMMMMMMMXMXXXXXXx.         ~~      MMMMM
   XMMMMMMMMMMMM?MMXXXXXXXXX!`         '+^  .MMM!P
   'MMM!MMMMMMMMMi?M!"`        `~%HHHHxx.  xMMMM"
   :MMMMMMMMMMMMMMM"               `\XMM .MMMMM
   XMMMMMMMMMX?MM!                   `( HMMMMM
  XMMMM)MMM"   \~                     'MMMMM*
 'MMMMfMMM"  \~                        XMMM*
.MMMMMXMM"  ^                          `MMM
XMMMM!MM"                               MM>
HMMMMXM~                                MM>
?MMMMM~                                 Xf%
 MMMMf                                  %% \
 4MMM                                    %
   `M                                     %
     %                                    %
     %                                     %
     %                 !                   %
      %                 !                   %
      %                 %                   !?%.
      %                  %                   X. %%.
       %                  %                  X!    %%.
       %                  %                  '!       %.
        %                  %                  !!         %.
        %                  %                  '!          `%
         %                  %                  !>          /%
         %                   %                 !!  Weboob  % %
          %                   %                 !          \%
          %                   %                 !!          %
           %                   %                '!         %~
            %                   %                !!       %~
            %%                  %                `!     %%
            %%%                  %                %++4MMf
             ?MMx                 %                %. MMX
              *MMMx               %                 !\'MMM>
               MMMMMHx    .....xxnH                  %HMMM>
                MMMMMMMMMMMMMMMMMMM>                  MMMMX
                'MMMMMMMMMMMMMMMMMMk                  'MMMM
                 'MMMMMMMMMMMMMMMMMM                   MMMM>
                  ?MMMMMMMMMMMMMMMMMM                  'MMMX
                   MMMMMMMMMMMMMMMMMMM                  MMMM
                   XMMMMM
-------------- next part --------------

  Weboob description
  ===================

     Weboob is a collection of applications able to interact with websites, without
     requiring the user to open them in a browser. It also provides well-defined APIs 
     to talk to websites lacking one. Weboob is a project which provides a core library,
     backends and applications.


   Overview
   ========
   
     The core library defines capabilities: features common to various websites. For
     example, http://www.youtube.com and http://www.dailymotion.com are both videos
     providers: Weboob defines the "ICapVideo" capability.
   
     Each backend interfaces a website and implements one or many of these
     capabilities. Backends can be configured, which means that the end-user can
     provide personal information to access the underlaying website (login/password
     for example).
  
     Applications offer the ability to the end-user to work with many backends in
     parallel, in a multi-threaded way. For example, one could search a video on
     many providers websites. Applications are toolkit-agnostic. They can use Gtk,
     Qt or text-only, more adapted to reuse data through pipes.
  
     The core library provides base classes which help the developer to write
     backends and applications.
  
     Weboob is written in Python and is distributed under the AGPLv3+ license.
     
     Dev page: http://symlink.me/projects/weboob/wiki/Development
     Bug report: http://symlink.me/projects/weboob/issues


  Weboob installation
  ===================

     Like any Python package using setuptools, Weboob can be installed in install
     mode or in development mode.


    Install mode
    ------------

     The install mode copies files to the Python system-wide packages directory
     (for example /usr/lib/python2.5/site-packages for Python 2.5,
     or /usr/local/lib/python2.6/dist-packages for Python 2.6)

     # ./setup.py install

     Scripts are copied to /usr/bin.
 
     Since there are many dependencies, when you install from sources,
     you have to handle them by hand, according to your distribution.
     If you still want to download them, you can uncomment the dependencies
     in setup.py

     To uninstall, remove the egg-info from the Python system-wide packages directory
     and remove the weboob_dev line in easy-install.pth.


    Development mode
    ----------------

     The development mode doesn't copy files, but creates an egg-link
     in the Python system-wide packages directory which points to the development
     directory. It is useful for development when files often change.

     # ./setup.py develop

     Scripts are copied to /usr/bin too.

     To uninstall, remove the egg-link from the Python system-wide packages directory
  
    Bash completion
    ---------------
  
     To enable bash completion, just source the tools/weboob_bash_completion
     file from your ~/.bash_completion file (which is sourced by /etc/bash_completion).


    Required packages
    -----------------
 
     python-gdata: http://code.google.com/p/gdata-python-client/
     python-html2text: http://www.aaronsw.com/2002/html2text/
     python-imaging: (Not on SBo): http://www.pythonware.com/products/pil/
     python-mechanize: http://wwwsearch.sourceforge.net/mechanize/
     python-pysqlite (Not on SBo):  http://pypi.python.org/pypi/pysqlite/
     python2-dateutil
     python2-elementtidy
     python2-feedparser
     python2-lxml
     python2-prettytable
     python2-pyqt
     python2-yaml
     which


    Optionnal packages
    -----------------

     Phonon (QVideoob)

   
    Applications 
    ------------

     Weboob is powered by a bunch of applications. Below is a list of what was available
     when this version were released. To check out the last ones, please go here: 
     http://weboob.org/applications/ .


      Graphical applications using the Qt toolkit
      -------------------------------------------    

       * QBoobMsg
           Read and post public and private messages. 

       * QFlatBoob
           Search for housings, bookmark and annotate them. 

       * QHaveDate
           Interact with dating websites, and manage your success. 

       * QVideoob
           Search for videos, get their direct URLs or play them. 

       * QWebContentEdit
           Edit content on supported collaborative websites like wikis. 

       * weboob-config-qt
           Show, install, update and configure backends.



      Textual applications, both command-line and REPL
      ------------------------------------------------

       * Boobank
           List your bank accounts balances, their expenses, transfer money, etc. 

       * Boobill
           List your subscriptions, view and download the bill details. 

       * Boobmsg
           Read and post public and private messages. 

       * Boobooks
           List your books rented and get your booking history. 

       * Boobtracker
           View, edit and create issues on bugtrackers. 

       * Flatboob
           Search for a house. 

       * Geolooc
           Geolocalize IP addresses. 

       * Havedate
           Interact with dating websites, and get popular. 

       * Pastoob
           Submit and get text (source code, backtraces) to pastebin-like websites. 

       * Radioob
           Search for radios, and get direct stream URLs and current playing songs. 

       * Traveloob
           View public transportation timetables. 

       * Videoob
           Search for videos, get their direct URLs, download them or play them. 

       * WebContent
           Edit Manage and edit content on supported collaborative websites like wikis. 

       * weboob-config
           Show, install, update and configure backends. 

       * Weboorrents
           Search for torrents and download the .torrent files. 

       * Wetboobs
           Display current weather water levels and to see forecasts.


      Applications meant to run in background
      ---------------------------------------

       * Monboob
           Receive and reply to messages by mail.


      Maemo (Nokia N900 smartphone)
      -----------------------------

       * Masstransit
           View public transportation timetables.

   Modules 
   =======

     A module is an interface between a website and Weboob. Modules are stored in 
     repositories and can be updated without upgrading Weboob.

     To check if there are new versions of modules, use this command:
      
      $ weboob-config update

     By default, only the default repository is enabled. You can add another one
     by editing the file ~/.config/weboob/sources.list.

     Stay tuned about the new modules:  http://updates.weboob.org/stable/main/rss2.xml

    
    Add a backend
    -------------

     Weboob applications need backends to interact with websites. A backend is a
     configured module, usually with several parameters like your username, password,
     or other options. You can create multiple backends for a single module.

     You can use a console application or a graphical application to edit backends.

    Available modules
    -----------------

     Official list: http://weboob.org/modules . 

    Arte
    AuM 
    Batoto 
    BNPorc
    Boursorama
    Bouygues 
    BP 
    CanalPlus
    CanalTP
    CappedTV
    CMB
    CrAgr
    CreditMutuel
    Dailymotion
    DLFP
    EatManga
    Ecrans
    EHentai
    FourChan
    FranceTelevisions
    FreeMobile
    Gazelle
    GeolocIP
    HdS
    HSBC
    INA
    ING
    Inrocks
    IPInfoDB
    isoHunt
    Izneo
    Kickass
    LCL
    LeFigaro
    MangaFox
    MangaHere
    MangaReader
    MediaWiki
    MeteoFrance
    Minutes20
    Newsfeed
    NolifeTV
    Nova
    Opacwebaloes
    Orange
    OuiFM
    PAP
    Pastealacon
    Pastebin
    phpBB
    PirateBay
    PressEurop
    RadioFrance
    Redmine
    Sachsen
    SeLoger
    SFR
    SimplyReadIt
    SocieteGenerale
    Transilien
    Yahoo
    YouJizz
    YouPorn
    YouTube

_____________________________________________________________________________________

                                 That's all folks!


                     nHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHn.
          .MS?MMMMMMMMMMMMMMMMMM?MM~MMMMMMMMMSHMMMMMMMM(?"~\
          MMMMMH?MMMMMMMX*MM?MMX%MM/MMMMMM"HMMMMMMMMMMMMMMH
         MMMMMMMMMMMMMMMMMX*MX*MMMX?MMMMM(M!XMMMMMMMMMMMMMMMX
        XMC)?MMMMMMMMMMMMMMMhX?!?MMMMX#MM!MXMMMMMMMMMMMML   '~
'\      MMMMMMMMMMMMMMMMMMMMMMMM!~`````-`~!?MMMM)MMMMMMMMx
   `~""MMM)MMMMMMMMMMMMMMMHhHH!~           `#MM(MMMMMMMMMM>
      HM!HMMMMMMMMMMMMMMMM*?)?`                `"MMMMMMMMMX       .
     XM!MMMMMMMMMMMMMMMMMMM?~                     'MMMMMMMM:..xx!`
     M!MMMMMMMMMMMMMMMMMXH!                        MMMMXMMP"`
    \!MMMMMMMSMHHHMM?XMM?~    -:::xx..             M?XMM?".x(
    MXMMMMMMMMMM!XHMMMM":       ... `"%x          XHHHMMM*"
   \!MMMMMMMM?XMMMMMMX!'~L     '%%%+:.  `       ..MMMMM"
   'HMMMMMM?HMMMMM*XM!    h     ~\).^\~     .%""`MM?"
   'MMMMMMMMMMMMMXMMM!    -X               +%%!.MMMXk
   ?MMMMMMMMMMMXMMMMM `.   ~               `""'XMMMMX
   !MMMMMMMMMMMMMMMMMX.    '                  XMkMMX>
   XMMMMMMMMMMMMMMM?MXXXx.-`                  XXMMM!
   MMMMMMMMMMMMMMMMXMXXXXXXx.         ~~      MMMMM
   XMMMMMMMMMMMM?MMXXXXXXXXX!`         '+^  .MMM!P
   'MMM!MMMMMMMMMi?M!"`        `~%HHHHxx.  xMMMM"
   :MMMMMMMMMMMMMMM"               `\XMM .MMMMM
   XMMMMMMMMMX?MM!                   `( HMMMMM
  XMMMM)MMM"   \~                     'MMMMM*
 'MMMMfMMM"  \~                        XMMM*
.MMMMMXMM"  ^                          `MMM
XMMMM!MM"                               MM>
HMMMMXM~                                MM>
?MMMMM~                                 Xf%
 MMMMf                                  %% \
 4MMM                                    %
   `M                                     %
     %                                    %
     %                                     %
     %                 !                   %
      %                 !                   %
      %                 %                   !?%.
      %                  %                   X. %%.
       %                  %                  X!    %%.
       %                  %                  '!       %.
        %                  %                  !!         %.
        %                  %                  '!          `%
         %                  %                  !>          /%
         %                   %                 !!  Weboob  % %
          %                   %                 !          \%
          %                   %                 !!          %
           %                   %                '!         %~
            %                   %                !!       %~
            %%                  %                `!     %%
            %%%                  %                %++4MMf
             ?MMx                 %                %. MMX
              *MMMx               %                 !\'MMM>
               MMMMMHx    .....xxnH                  %HMMM>
                MMMMMMMMMMMMMMMMMMM>                  MMMMX
                'MMMMMMMMMMMMMMMMMMk                  'MMMM
                 'MMMMMMMMMMMMMMMMMM                   MMMM>
                  ?MMMMMMMMMMMMMMMMMM                  'MMMX
                   MMMMMMMMMMMMMMMMMMM                  MMMM
                   XMMMMM


More information about the weboob mailing list