From bea2c4ac177f9e2a5fbda04baa1e0c3f13bb3e0c Mon Sep 17 00:00:00 2001 From: "Phyks (Lucas Verney)" Date: Tue, 24 Oct 2017 17:17:20 -0400 Subject: [PATCH] Add weboob and weboob-modules in requirements.txt, fix #79. --- doc/0.getting_started.md | 24 +++++++++++++++++++++--- requirements.txt | 3 ++- 2 files changed, 23 insertions(+), 4 deletions(-) diff --git a/doc/0.getting_started.md b/doc/0.getting_started.md index b90dfe7..e0473c8 100644 --- a/doc/0.getting_started.md +++ b/doc/0.getting_started.md @@ -1,14 +1,32 @@ Getting started =============== + +## Dependency on Weboob + **Important**: Flatisfy relies on [Weboob](http://weboob.org/) to fetch housing posts from housing websites. Then, you should install the [`devel` branch](https://git.weboob.org/weboob/devel/) and update it regularly, especially if Flatisfy suddenly stops fetching housing posts. -**Note**: For the moment, it requires [this MR on -Weboob](https://git.weboob.org/weboob/devel/merge_requests/31) which has not -yet been merged. +If you `pip install -r requirements.txt` it will install the latest +development version of [Weboob](https://git.weboob.org/weboob/devel/) and the +[Weboob modules](https://git.weboob.org/weboob/modules/), which should be the +best version available out there. You should update these packages regularly, +as they evolve quickly. + +Weboob is made of two parts: a core and modules (which is the actual code +fetching data from websites). Modules tend to break often and are then updated +often, you should keep them up to date. This can be done by installing the +`weboob-modules` package listed in the `requirements.txt` and using the +default configuration. + +This is a safe default configuration. However, a better option is usually to +clone [Weboob git repo](https://git.weboob.org/weboob/devel/) somewhere, on +your disk, to point `modules_path` configuration option to +`path_to_weboob_git/modules` (see the configuration section below) and to run +a `git pull; python setup.py install` in the Weboob git repo often. + ## TL;DR diff --git a/requirements.txt b/requirements.txt index 610ecc8..5078472 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,4 +11,5 @@ requests sqlalchemy unidecode whoosh -weboob>=1.4 +https://git.weboob.org/weboob/devel/repository/archive.zip?ref=master +https://git.weboob.org/weboob/modules/repository/archive.zip?ref=master