https://github.com/baumac/RentalPropertyScraper

Scrapes real estate listing to find the best rental properties.
https://github.com/baumac/RentalPropertyScraper

Last synced: 4 months ago
JSON representation

Scrapes real estate listing to find the best rental properties.

• Host: GitHub
• URL: https://github.com/baumac/RentalPropertyScraper
• Owner: baumac
• License: gpl-3.0
• Created: 2021-01-01T02:28:41.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-05-17T10:39:54.000Z (almost 3 years ago)
• Last Synced: 2024-04-09T05:36:25.131Z (11 months ago)
• Language: Python
• Homepage:
• Size: 21.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rental Property Scraper 

## Description

This Python app uses Selenium Webdriver to scrape property listings from real estate websites. 

The app gathers the listing price, annual rental income, and url to the listing and then stores it in a csv file. 

### Technology used

1. Python - the programming language

2. Selenium Webdriver - to scrape the web pages

3. Docker - to provide a stable runtime environment

### Supported websites: 

1. Redfin

---

## Usage

#### Note: make sure to update the config.yaml file located in the project root

The application has two ways to build and run it in a docker container:

1. Using a run script

2. Manually running it using docker

3. Running it locally with Python3

### Run Script Usage:

From the project root you can run any of these commands:

- ./run buildApp - Builds the application's docker container and tags it as rental_property_scraper:latest.

- ./run runApp - Runs the application's docker container.

- ./run buildAndRunApp - Builds and then runs the application's docker container.

### Manual Docker Usage:

From the project root run the following commands in order:

1. `docker build -t rental_property_scraper:latest -f Dockerfile .` - build the application docker container

2. `docker run rental_property_scraper:latest` - run the docker container

### Local usage with Python3:

1. pip install -r requirements.txt

2. python3 main.py