Add weboob and weboob-modules in requirements.txt, fix #79.
This commit is contained in:
parent
1d6233e5ca
commit
bea2c4ac17
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user