-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2f5ea1c
commit df3519a
Showing
1 changed file
with
27 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,35 @@ | ||
**HomeHarvest** aims to be the top Python real estate scraping library. | ||
# HomeHarvest | ||
|
||
**HomeHarvest** aims to be the top Python real estate scraping library. | ||
|
||
## RoadMap | ||
|
||
- Currently, supports scraping from **RedFin** | ||
- Coming soon: Support for **Zillow** and other real estate platforms | ||
- Under consideration: Excel plugin to attract a wider audience | ||
- **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` | ||
|
||
### Installation | ||
|
||
```bash | ||
pip install --upgrade homeharvest | ||
``` | ||
|
||
### Example Usage | ||
``` | ||
from homeharvest import scrape_property | ||
properties = scrape_property( | ||
location="85281", site_name="zillow", listing_type="for_rent" | ||
) | ||
print(properties) | ||
``` |