Skip to content

Commit

Permalink
Remove 'add a site' from README
Browse files Browse the repository at this point in the history
  • Loading branch information
mikepqr committed Sep 27, 2021
1 parent 3b2c2ec commit d579359
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 12 deletions.
11 changes: 0 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,6 @@ chart make the estimate look ridiculously trustworthy. This scraper captures the
bouncing, which gives you a good idea how much to trust the current value
(probably good to 10-20% at most).

## Adding a new site

To add a new site:

- add an entry in `sites.json`
- set `xpath` to the xpath containing the piece of data you want to collect
- export the `<NAME>_URL` environment variable, where `<NAME>` should be
replaced with the upper case version of the `"name"` field in sites.json.
- if you want to keep the history in `data.csv` manually edit its header to add
the new site (otherwise `data.csv` will be overwritten with an empty table).

## Caveats

- The Zillow scraper doesn't work if the house is on the market. The page
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = real-estate-scrape
version = 0.1.0
version = 0.1.1
description = Get the estimated value of a property from Redfin and Zillow
long_description = file: README.md
long_description_content_type = text/markdown
Expand Down

0 comments on commit d579359

Please sign in to comment.