Metadata-Version: 1.1
Name: pyzillow
Version: 0.3.0
Summary: Python API wrapper for Zillow's API
Home-page: https://github.com/hanneshapke/pyzillow
Author: Hannes Hapke
Author-email: hannes.hapke@gmail.com
License: MIT
Description: =============================
        PyZillow
        =============================
        
        .. image:: https://badge.fury.io/py/pyzillow.png
            :target: http://badge.fury.io/py/pyzillow
        
        .. image:: https://travis-ci.org/hanneshapke/pyzillow.png?branch=master
            :target: https://travis-ci.org/hanneshapke/pyzillow
        
        .. image:: https://pypip.in/d/pyzillow/badge.png
            :target: https://pypi.python.org/pypi/pyzillow
        
        .. image:: https://coveralls.io/repos/hanneshapke/pyzillow/badge.png
          :target: https://coveralls.io/r/hanneshapke/pyzillow
        
        .. image:: https://readthedocs.org/projects/pyzillow/badge/?version=latest 
          :target: https://readthedocs.org/projects/pyzillow
        
        
        Python API wrapper for Zillow's API
        
        Documentation available here: http://pyzillow.readthedocs.org/en/latest/
        
        Currrently it is supporting the GetDeepSearchResults and GetUpdatedPropertyDetails API. 
        
        It allows you to directly convert an address/zipcode (GetDeepSearchResults API) or zillow id (GetUpdatedPropertyDetails API) into
        real estate data based on the Zillow database.
        
        Installation
        ------------
        You can install this package using pip:
        
            pip install pyzillow
        
        or download the source from https://github.com/hanneshapke/pyzillow and install
        
            python setup.py install
        
        
        Usage of the GetDeepSearchResults API
        -------------------------------------
        
            from pyzillow import ZillowWrapper, GetDeepSearchResults
            ...
            address = 'YOUR ADDRESS'
            zipcode = 'YOUR ZIPCODE'
            ...
            zillow_data = ZillowWrapper(YOUR_ZILLOW_API_KEY)
            deep_search_response = zillow_data.get_deep_search_results(address, zipcode)
            result = GetDeepSearchResults(deep_search_response) 
            ...
            result.zillow_id # zillow id, needed for the GetUpdatedPropertyDetails
        
        The following attributes are currently supported:
        
            - zillow_id
            - home_type
            - home_detail_link
            - graph_data_link
            - map_this_home_link
            - latitude
            - latitude
            - coordinates (as GEOS point)
            - tax_year
            - tax_value
            - year_built
            - property_size
            - home_size
            - bathrooms
            - bedrooms
            - last_sold_date
            - last_sold_price_currency
            - last_sold_price
            - zestimate_amount
            - zestimate_last_updated
            - zestimate_value_change
            - zestimate_valuation_range_high
            - zestimate_valuationRange_low
            - zestimate_percentile
        
        
        Usage of the GetUpdatedPropertyDetails API
        ------------------------------------------
        
            from pyzillow import ZillowWrapper, GetUpdatedPropertyDetails
            ...
            zillow_id = 'YOUR ZILLOW ID'
            ...
            zillow_data = ZillowWrapper(YOUR_ZILLOW_API_KEY)
            updated_property_details_response = zillow_data.get_updated_property_details(zillow_id)
            result = GetUpdatedPropertyDetails(updated_property_details_response) 
            ...
            result.rooms # number of rooms of the home
        
        The following attributes are currently supported:
        
            - zillow_id
            - home_type
            - home_detail_link
            - photo_gallery
            - latitude
            - latitude
            - coordinates (as GEOS point)
            - year_built
            - property_size
            - home_size
            - bathrooms
            - bedrooms
            - home_info
            - year_updated
            - floor_material
            - num_floors
            - basement
            - roof
            - view
            - parking_type
            - heating_sources
            - heating_system
            - rooms
            - home_description
            - neighborhood
            - school_district
        
        The following attributes are not provided by the API:
        
            - graph_data_link
            - map_this_home_link
            - tax_year
            - tax_value
            - last_sold_date
            - last_sold_price_currency
            - last_sold_price
        
        
        Contact Information
        -------------------
        Author: Hannes Hapke (renooble)
        Twitter: @hanneshapke
        Internet: https://hanneshapke.github.io/ 
        
        For comments, issues, requests, please contact via Github at the above website
        
        
        Documentation
        -------------
        
        The full documentation is at http://pyzillow.rtfd.org.
        
        
        
        History
        -------
        
        0.4.0 (2014-12-20)
        ++++++++++++++++++
        
        * Zestimate extracted from Zillow's GetDeepSearchResults API.
        
        0.3.1 (2014-12-20)
        ++++++++++++++++++
        
        * Added test cases and increased test coverage setup.
        
        0.3.0 (2014-12-19)
        ++++++++++++++++++
        
        * Refactored structure, travis CI compliance, coverage setup.
        
        0.2.7
        ++++++++++++++++++
        
        * Bug fix: Missing ParseError, numRooms now read from UpdatedProperty
        
        0.2.6
        ++++++++++++++++++
        
        * Bug fix
        
        0.2.5
        ++++++++++++++++++
        
        * Using markdown as README file for setup.py
        
        0.2.4
        ++++++++++++++++++
        
        * Coordinates provides as GEOS point
        
        0.2.3
        ++++++++++++++++++
        
        * New attributes added: home_description, num_floors, floor_material, parking_type
        
        0.2.2
        ++++++++++++++++++
        
        * Licence changed to MIT
        
        0.2.1
        ++++++++++++++++++
        
        * pip created and code refactured
        
        0.2
        ++++++++++++++++++
        
        * API Wrapper for the GetDeepSearchResults and GetUpdatedPropertyDetails API. test.py and setup.py created.
        
        0.1
        ++++++++++++++++++
        
        * Project created
Keywords: pyzillow
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
