https://github.com/simonrw/housefinder
For finding houses using zoopla
https://github.com/simonrw/housefinder
Last synced: 9 months ago
JSON representation
For finding houses using zoopla
- Host: GitHub
- URL: https://github.com/simonrw/housefinder
- Owner: simonrw
- License: mit
- Created: 2016-08-04T09:15:56.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-01-29T20:24:33.000Z (over 8 years ago)
- Last Synced: 2025-02-06T08:45:21.002Z (over 1 year ago)
- Language: Python
- Size: 14.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# housefinder
For finding houses using Zoopla.
Inspired by [this blog post][1], this repository queries the [Zoopla] API to
find houses. I have generalised the code to allow a custom search area, along
with inputing your own api keys.
The code inserts listings into a `postgres` database for further querying later
on, and for de-duplication of listings.
## Plan
The plan is to post the listings to [Trello] so my wife and I can discuss
together. At the moment it posts to a slack channel, but neither of us use
slack.
## Requirements
* Python 3
* `requests`
* `sqlalchemy`
* `psycopg2`
A postgres database owned by the current user account called `housefinder`.
## Running
Copy the `config.cfg.example` file to `config.cfg` and fill out the details.
You can get a Zoopla api key if you create an account with them, and [visit
your account settings page][2]. You can get a slack api key if you [add a bot
user][3] to your organisation. Finally a Trello api key can be generated [using
their developer documentation][4].
Install the package with
```sh
pip install git+https://github.com/mindriot101/housefinder.git
```
and run the command `housefinder -c `.
[1]: https://www.dataquest.io/blog/apartment-finding-slackbot/
[Zoopla]: http://www.zoopla.co.uk/
[Trello]: https://trello.com/
[2]: http://developer.zoopla.com/apps/mykeys
[3]: https://api.slack.com/bot-users
[4]: https://developers.trello.com/