Update README.md

pull/1/head
Zachary Hampton 2023-09-18 08:38:56 -07:00 committed by GitHub
parent 54af03c86a
commit 29897b8fbe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 19 deletions

View File

@ -2,31 +2,15 @@
**HomeHarvest** aims to be the top Python real estate scraping library.
## RoadMap
_**Under Consideration**: We're looking into the possibility of an Excel plugin to cater to a broader 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`
- `realtor.com`
## Listing Types
- `for_rent`
- `for_sale`
- `sold`
### Installation
## Installation
```bash
pip install --upgrade homeharvest
```
### Example Usage
## Example Usage
```
from homeharvest import scrape_property
@ -35,3 +19,15 @@ properties = scrape_property(
)
print(properties)
```
### Site Name Options
- `zillow`
- `redfin`
- `realtor.com`
### Listing Types
- `for_rent`
- `for_sale`
- `sold`