2023-09-17 13:10:21 -07:00
|
|
|
# HomeHarvest
|
|
|
|
|
|
|
|
**HomeHarvest** aims to be the top Python real estate scraping library.
|
2023-09-15 19:47:46 -07:00
|
|
|
|
|
|
|
## RoadMap
|
|
|
|
|
2023-09-17 13:10:21 -07:00
|
|
|
- **Supported Sites**: Currently, we support scraping from sites such as `Zillow` and `RedFin`.
|
|
|
|
- **Output**: Provides the option to return the scraped data as a Pandas dataframe.
|
|
|
|
- **Under Consideration**: We're looking into the possibility of an Excel plugin to cater to a broader audience.
|
|
|
|
|
|
|
|
## Site Name Options
|
|
|
|
|
|
|
|
- `zillow`
|
|
|
|
- `redfin`
|
|
|
|
|
|
|
|
## Listing Types
|
|
|
|
|
|
|
|
- `for_rent`
|
|
|
|
- `for_sale`
|
2023-09-15 19:47:46 -07:00
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
|
|
```bash
|
|
|
|
pip install --upgrade homeharvest
|
2023-09-17 13:10:21 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
### Example Usage
|
|
|
|
```
|
|
|
|
from homeharvest import scrape_property
|
|
|
|
|
|
|
|
properties = scrape_property(
|
|
|
|
location="85281", site_name="zillow", listing_type="for_rent"
|
|
|
|
)
|
|
|
|
print(properties)
|
|
|
|
```
|