This is a dummy project that aims to build an API that enables users to navigate the rental market.
The API should be able to work properly in Bordeaux:
- Contextual information can be retrieved from OpenStreetMap, Bordeaux's open data websites and any other sources you see fit.
- Rental listings can be scraped from various websites such as leboncoin.fr or seloger.com.
With Docker:
docker-compose up
- copy this URL into your web browser: http://admin:default@127.0.0.1:9999/listings
Without Docker:
virtualenv env
source env/bin/activate
pip install pip setuptools --upgrade
pip install -r requirements.txt
python setup.py develop
python app/common/init_db.py
python app/api.py
If you want to see your modifications, use docker-compose up --force-recreate --build
.
- Make sure
/listings:search
returns results as specified in theswagger.yml
file. - Add
tram_stop
andbus_stop
to the amenities (datasets are available on the open data website) - Make sure
Listing
table is refreshed every 15 minutes (remove no longer available listings and add new ones) - Store user's most recent search and send them an email notification when a new listing that matches their search criteria appears.