turtlebasket
/
HomeHarvest
mirror of https://github.com/Bunsly/HomeHarvest.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

pull/5/head
Zachary Hampton 2023-09-18 17:45:14 -07:00 committed by GitHub
parent fbbd56d930
commit ae3961514b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -30,20 +30,8 @@ properties: pd.DataFrame = scrape_property(
listing_type="for_rent" # for_sale / sold listing_type="for_rent" # for_sale / sold
) )
#1 output to .csv (simplest, then use Excel) #: Note, to export to CSV or Excel, use properties.to_csv() or properties.to_excel().
properties.to_csv('props.csv', index=False) print(properties)
#2 display in Jupyter Notebook (1. pip install jupyter 2. jupyter notebook)
# formatting for pandas
#pd.set_option('display.max_columns', None)
#pd.set_option('display.max_rows', None)
#pd.set_option('display.width', None)
#pd.set_option('display.max_colwidth', 50) # set to 0 to see full property_url / descr
#display(properties)
#3 output to console
#print(properties)
``` ```
@ -106,7 +94,7 @@ Property
│ ├── status_text (str) │ ├── status_text (str)
│ ├── latitude (float) │ ├── latitude (float)
│ ├── longitude (float) │ ├── longitude (float)
│ └── posted_time (str) │ └── posted_time (str) [Only for Zillow]
├── Building Details (for property_type: building): ├── Building Details (for property_type: building):
│ ├── bldg_name (str) │ ├── bldg_name (str)
@ -130,14 +118,14 @@ The following exceptions may be raised when using HomeHarvest:
- `InvalidSite` - valid options: `zillow`, `redfin`, `realtor.com` - `InvalidSite` - valid options: `zillow`, `redfin`, `realtor.com`
- `InvalidListingType` - valid options: `for_sale`, `for_rent`, `sold` - `InvalidListingType` - valid options: `for_sale`, `for_rent`, `sold`
- `NoResultsFound` - no properties found from your input - `NoResultsFound` - no properties found from your input
- `GeoCoordsNotFound` - if Zillow scraper is not able to create geo-coordinates from the locaion you input - `GeoCoordsNotFound` - if Zillow scraper is not able to create geo-coordinates from the location you input
## Frequently Asked Questions ## Frequently Asked Questions
--- ---
**Q: Encountering issues with your queries?** **Q: Encountering issues with your queries?**
**A:** Try a single site and/or broadening the location. If problems persist, [submit an issue](https://github.com/ZacharyHampton/HomeHarvest/issues). **A:** Try a single site and/or broaden the location. If problems persist, [submit an issue](https://github.com/ZacharyHampton/HomeHarvest/issues).
--- ---