python-craigslist
requests
python >= 3.5.0
The above dependencies can be installed by runningpip3 install -r requirements.txt
in the cloned repo directory.
You can simply run the script by typing python3 apartment_finder.py
inside the cloned repo. The present Procfile can be used for deployment on an external server(e.g. you can run it on Heroku using heroku run apartment_finder.py
).
The exisiting config.json
file can (and should) be modified to match your preferences.
city
,craigslist_site
,craigslist_area
: please refer to Craigslist for your city codesbounding_boxes
: a dictonary mapping neighborhood names to their bounding boxes coordinates, please refer to the sampleconfig.json
for the correct structure.from_email
,password
: your email credentialsto_email
: a list of destination emailsrun_interval
: how often the script should be run in minutes (default is 20)