Phyks (Lucas Verney)
Merge pull request #14 from guix77/doc
|1 month ago|
|.ci||1 year ago|
|doc||1 month ago|
|docker||8 months ago|
|flatisfy||3 months ago|
|hooks||2 years ago|
|migrations||6 months ago|
|.babelrc||2 years ago|
|.eslintrc||2 years ago|
|.gitignore||1 month ago|
|.gitlab-ci.yml||1 year ago|
|CONTRIBUTING.md||6 months ago|
|CodeOfConduct.md||1 year ago|
|LICENSE.md||2 years ago|
|README.md||9 months ago|
|alembic.ini||6 months ago|
|package.json||1 year ago|
|requirements.txt||6 months ago|
|webpack.config.js||2 years ago|
|wsgi.py||2 years ago|
Flatisfy is your new companion to ease your search of a new housing :)
Note: This software is under heavy development at the moment, and the database schema could change at any time. Do not consider it as being production ready. However, I am currently using it for my own housing search and it is working fine :)
It uses WebOOB to get all the housing posts on most of the websites offering housings posts, and then offers a bunch of pipelines to filter and deduplicate the fetched housings.
It can be used as a command-line utility, but also exposes a web API and visualisation, to browse through the results.
Note: It is targeted at French users (due to the currently supported websites), and in particular at people living close to Paris, as I developped it for my personal use, and am currently living in Paris :) Any feedback and merge requests to better support other countries / cities are more than welcome!
Note: In this repository and across the code, I am using the name “flat”. I use it as a placeholder for “housing” and consider both are interchangeable. This code is not restricted to handling flats only!
Documentation for the whole app is available online.
See the dedicated folder.
Display available flats on a map:
And list them with the details in a sortable table:
Uniform display of the flat information in a dedicated page, with the contact etc:
Track interesting flats and store them with notes:
I am using the following datasets, available under
which covers Paris. If you want to run the script using some other location,
you might have to change these files by matching datasets.
stops_fr-*.txtfiles, extracted from the
NTFSdatasets for each region.
Both datasets are licensed under the Open Data Commons Open Database License (ODbL): https://opendatacommons.org/licenses/odbl/.
The content of this repository is licensed under an MIT license, unless explicitly mentionned otherwise.
CONTRIBUTING.md file for more infos.
Your Flatisfy instance is accessible through an API. API documentation is available here.
Feel free to open issues. An IRC channel is available at irc://irc.freenode.net/flatisfy as well.