chore: merge

HomeHarvest_Demo.ipynb

@@ -31,11 +31,33 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# scrapes all 3 sites by default\n",
     "scrape_property(\n",
-    "    location=\"dallas\", site_name=\"zillow\", listing_type=\"for_sale\"\n",
+    "    location=\"dallas\",\n",
+    "    listing_type=\"for_sale\"\n",
     ")"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "aaf86093",
+   "metadata": {
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
+   },
+   "outputs": [],
+   "source": [
+    "# search a specific address\n",
+    "scrape_property(\n",
+    "    location=\"2530 Al Lipscomb Way\",\n",
+    "    site_name=\"zillow\",\n",
+    "    listing_type=\"for_sale\"\n",
+    "),"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -43,8 +65,31 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# check rentals\n",
     "scrape_property(\n",
-    "    location=\"dallas\", site_name=\"redfin\", listing_type=\"for_sale\"\n",
+    "    location=\"chicago\",\n",
+    "    site_name=[\"redfin\", \"realtor.com\"],\n",
+    "    listing_type=\"for_rent\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "af280cd3",
+   "metadata": {
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
+   },
+   "outputs": [],
+   "source": [
+    "# check sold properties\n",
+    "scrape_property(\n",
+    "    location=\"chicago, illinois\",\n",
+    "    site_name=[\"redfin\"],\n",
+    "    listing_type=\"sold\"\n",
     ")"
    ]
   }

README.md

@@ -37,8 +37,8 @@ print(properties)
 ```
 ## Output
 ```py
->>> properties.head()
+>> properties.head()
-                           street        city  ... mls_id description
+                                street   city  ... mls_id description
 0                 420 N  Scottsdale Rd  Tempe  ...    NaN         NaN
 1                1255 E  University Dr  Tempe  ...    NaN         NaN
 2              1979 E  Rio Salado Pkwy  Tempe  ...    NaN         NaN
@@ -118,7 +118,7 @@ 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 location you input
+- `GeoCoordsNotFound` - if Zillow scraper is not able to find the geo-coordinates from the `location`
 
 ## Frequently Asked Questions