docs: add example

pull/1/head
Cullen Watson 2023-09-17 15:10:21 -05:00 committed by GitHub
parent 2f5ea1ca88
commit df3519ae18
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 4 deletions

View File

@ -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)
```