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

Merge remote-tracking branch 'origin' into tidy_up_readme

pull/6/head
Cullen Watson 2023-09-18 20:01:59 -05:00
parent cc76e067b2 1f0c351974
commit 906ce92685
2 changed files with 5 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -30,20 +30,8 @@ properties: pd.DataFrame = scrape_property(
listing_type="for_rent" # for_sale / sold
)
#1 output to .csv (simplest, then use Excel)
properties.to_csv('props.csv', index=False)
#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)
#: Note, to export to CSV or Excel, use properties.to_csv() or properties.to_excel().
print(properties)
```
@ -130,14 +118,14 @@ The following exceptions may be raised when using HomeHarvest:
- `InvalidSite` - valid options: `zillow`, `redfin`, `realtor.com`
- `InvalidListingType` - valid options: `for_sale`, `for_rent`, `sold`
- `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
---
**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).
---

2
pyproject.toml
View File

@ -1,7 +1,7 @@
[tool.poetry]
name = "homeharvest"
version = "0.2.0"
description = "Real estate scraping library"
description = "Real estate scraping library supporting Zillow, Realtor.com & Redfin."
authors = ["Zachary Hampton <zachary@zacharysproducts.com>", "Cullen Watson <cullen@cullen.ai>"]
homepage = "https://github.com/ZacharyHampton/HomeHarvest"
readme = "README.md"