Merge pull request #33 from hanneshapke/develop

Create 0.7 release

CONTRIBUTING.rst

@@ -22,7 +22,7 @@ If you are reporting a bug, please include:
 Fixing bugs
 ~~~~~~~~~~~
 
-Look through the `GitHub issues <https://github.com/hanneshapke/pyzillow/issues>`_ for bugs. Anything tagged with "bug"
+Fixes are always welcome! Look through the `GitHub issues <https://github.com/hanneshapke/pyzillow/issues>`_ for bugs. Anything tagged with "bug"
 is open to whoever wants to fix it.
 
 Implementing features
@@ -51,55 +51,60 @@ If you are proposing a feature:
   are welcome :)
 
 Getting started
---------------
+---------------
 
 Ready to contribute? Here's how to set up PyZillow for
 local development.
 
-1. Fork_ the `pyzillow` repo on GitHub.
-2. Clone your fork locally::
+Fork_ the `pyzillow` repo on GitHub.
 
-        $ git clone git@github.com:hanneshapke/pyzillow.git
+Clone your fork locally::
 
-3. Create a branch for local development::
+   $ git clone git@github.com:hanneshapke/pyzillow.git
 
-        $ git checkout -b name-of-your-bugfix-or-feature
+Create a branch for local development::
+
+   $ git checkout -b name-of-your-bugfix-or-feature
+
+Create a virtualenv to separate your Python dependencies:
+
+   $ virtualenv .pyzillow-env && source .pyzillow-env/bin/activate
+
+Configure development requirements::
+
+   $ make develop
 
 Now you can make your changes locally.
 
-4. When you're done making changes, use ``tox`` to check that your changes pass style and unit
-   tests, including testing other Python versions::
+When you're done making changes, use `Pytest <https://docs.pytest.org/en/latest/>`_ to check that your changes pass style and unit tests, including testing other Python versions. You can run all tests by running pytest::
+
+    $ pytest
 
-    $ tox
+Please lint your code before committing your changes::
 
-To get tox, just pip install it.
+   $ make lint
 
-5. Commit your changes and push your branch to GitHub::
+Commit your changes and push your branch to GitHub::
 
     $ git add .
     $ git commit -m "Your detailed description of your changes."
     $ git push origin name-of-your-bugfix-or-feature
 
-6. Submit a pull request through the GitHub website.
-
-.. _Fork: https://github.com/hanneshapke/pyzillow/fork
-
 Submitting a pull request
 -------------------------
 
 Check that your pull request meets these guidelines before you submit it:
 
 1. The pull request should include tests.
-2. If the pull request adds functionality, the docs have to be updated. Put
-   your new functionality into a function with a docstring, and add the
-   feature to the list in README.rst.
-3. The pull request should work with Python 3.6, 3.7 and 3.8.
-   Check https://travis-ci.org/hanneshapke/pyzillow
-   under pull requests for active pull requests or run the ``tox`` command and
-   make sure that the tests pass for all supported Python versions.
+2. If the pull request adds functionality, the docs need to be updated. Include
+   docstrings with your new functionality (`Sphinx <https://www.sphinx-doc.org/en/stable/usage/extensions/autodoc.html>`_ reStructuredText) and check if you
+   need to update the information in the /docs/ folder.
+3. The pull request should work with Python 3.6, 3.7 and 3.8. Make sure that
+   all tests run by pytest pass.
 
 Running a subset of tests
 -------------------------
-Use pytest in case you want to run a subset of tests::
+Use pytest in combination with a substring in case you want to run only specific tests instead of all available tests.
+pytest will only run tests with names matching the substring::
 
-    $ pytest test/test_pyzillow.py
+    $ pytest -k <substring> -v

HISTORY.rst

@@ -7,12 +7,15 @@ Version history
 0.7.0 (2020-05-30)
 ++++++++++++++++++
 
-* * Updated error handling, too many request error, Github issue 18
-* Pinned python-coveralls to latest version 2.9.3 #27
-* Added `zestimate_valuation_range_low` as an attribute GetDeepSearchResults. `zestimate_valuationRange_low` was deprecated. ()
+* Updated error handling, too many request error, Github issue 18
+* Updated error handling, error 6 (Github issue 6)
+* Pinned python-coveralls to latest version 2.9.3 (#27)
 * Added posting details to GetUpdatedPropertyDetails result (#10)
+* Updated pytest version (#32)
+* Updated coverage version (#28)
+* Added support for additional API fields (#16)
 
-Thanks to Alexandra M. Chace, Marilyn Chace, Evan Pete Walsh, Stephen Holsapple
+Thanks to Alexandra M. Chace (#16), Marilyn Chace, Evan Pete Walsh (#11), Stephen Holsapple (#10), ZAD-Man (Issue #6)
 
 
 0.6.0 (2020-05-28)

README.md

@@ -1,14 +1,31 @@
-PyZillow 0.6
+PyZillow 0.7
 ============
 
-PyZillow is a Python wrapper for Zillow's API (http://www.zillow.com/howto/api/APIOverview.htm). With PyZillow, you can use a physical address or a Zillow ID to access real estate data from the Zillow database.
+![PyPI - Downloads](https://img.shields.io/pypi/dm/pyzillow)
+[![Build Status](https://travis-ci.com/hanneshapke/pyzillow.svg?branch=master)](https://travis-ci.com/hanneshapke/pyzillow)
+[![Documentation Status](https://readthedocs.org/projects/pyzillow/badge/?version=latest)](https://pyzillow.readthedocs.io/en/latest/?badge=latest)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+PyZillow is a Python wrapper for Zillow's API (<http://www.zillow.com/howto/api/APIOverview.htm>). With PyZillow, you can use a physical address or a Zillow ID to access real estate data from the Zillow database.
 
 Currently, PyZillow supports the **GetDeepSearchResults** and **GetUpdatedPropertyDetails** API endpoints.
 
+Status
+------
+
+PyZillow is now being actively updated again. Please allow us some time
+to work through existing pull requests and issues.
+
 Documentation
 -------------
 
-The PyZillow documentation is available here: http://pyzillow.readthedocs.org/en/latest/
+The PyZillow documentation is available here: <http://pyzillow.readthedocs.org/en/latest/>
+
+Maintainers
+-----------
+
+* Timo Cornelius Metzger <pyzillow@tcmetzger.net>
+* Hannes Hapke <hannes@renooble.com>
 
 Contributors
 ------------
@@ -19,4 +36,4 @@ Contributors
 * Miguel Paolino <miguel@renooble.com>
 * Timo Cornelius Metzger <pyzillow@tcmetzger.net>
 
-PyZillow was originally developed by Hannes Hapke and Miguel Paolino for [renooble.com](http://www.renooble.com).
+PyZillow was originally developed by Hannes Hapke and Miguel Paolino for [renooble.com](<http://www.renooble.com>).

README.rst

@@ -1,15 +1,40 @@
-PyZillow 0.6
+PyZillow 0.7
 ============
 
+.. image:: https://img.shields.io/pypi/dm/pyzillow.svg
+  :target: https://pypistats.org/packages/pyzillow
+  :alt: PyPI - Downloads
+.. image:: https://travis-ci.com/hanneshapke/pyzillow.svg?branch=master
+  :target: https://travis-ci.com/hanneshapke/pyzillow
+  :alt: Travis CI Build Status
+.. image:: https://readthedocs.org/projects/pyzillow/badge/?version=latest
+  :target: https://pyzillow.readthedocs.io/en/latest/?badge=latest
+  :alt: Documentation Status
+.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
+  :target: https://opensource.org/licenses/MIT
+  :alt: License: MIT
+
 PyZillow is a Python wrapper for `Zillow's API <http://www.zillow.com/howto/api/APIOverview.htm>`_. With PyZillow, you can use a physical address or a Zillow ID to access real estate data from the Zillow database.
 
 Currently, PyZillow supports the **GetDeepSearchResults** and **GetUpdatedPropertyDetails** API endpoints.
 
+Status
+------
+
+PyZillow is now being actively updated again. Please allow us some time
+to work through existing pull requests and issues.
+
 Documentation
 -------------
 
 The PyZillow documentation is available here: http://pyzillow.readthedocs.org/en/latest/
 
+Maintainers
+-----------
+
+* Timo Cornelius Metzger <pyzillow@tcmetzger.net>
+* Hannes Hapke <hannes@renooble.com>
+
 Contributors
 ------------
 

docs/getting_started.rst

@@ -30,6 +30,8 @@ To query the GetDeepSearchResults API:
 An instance of ``GetDeepSearchResults`` has the following attributes:
 ``.bathrooms``
 ``.bedrooms``
+``.city``
+``.fips_county``
 ``.graph_data_link``
 ``.home_detail_link``
 ``.home_size``
@@ -45,8 +47,12 @@ An instance of ``GetDeepSearchResults`` has the following attributes:
 ``.rentzestimate_valuation_range_high``
 ``.rentzestimate_valuation_range_low``
 ``.rentzestimate_value_change``
+``.state``
+``.street``
 ``.tax_value``
 ``.tax_year``
+``.total_rooms``
+``.use_code``
 ``.year_built``
 ``.zestimate_amount``
 ``.zestimate_last_updated``
@@ -55,6 +61,7 @@ An instance of ``GetDeepSearchResults`` has the following attributes:
 ``.zestimate_valuation_range_low``
 ``.zestimate_value_change``
 ``.zillow_id``
+``.zipcode``
 
 Access the information by reading the ``GetDeepSearchResults`` object's attributes. For example:
 
@@ -67,7 +74,8 @@ Accessing the GetUpdatedPropertyDetails API
 *******************************************
 The GetUpdatedPropertyDetails API endpoint requires a Zillow Property ID (ZPID) as an argument. To find this identifier, you can read the attribute ``.zillow_id`` of a GetDeepSearchResults object.
 
-Compared to the GetDeepSearchResults API endpoint described above, the GetUpdatedPropertyDetails API endpoint delivers more details about the object, such as ``.heating_system`` or ``.school_district``. However, it does not include Zestimate or Rentzestimate information.
+Compared to the GetDeepSearchResults API endpoint described above, the GetUpdatedPropertyDetails API endpoint delivers more details about the object, such as ``.heating_system`` or ``.school_district``.
+However, GetUpdatedPropertyDetails data is not available for all valid Zillow Property IDs.
 
 To query the GetUpdatedPropertyDetails API:
 
@@ -84,39 +92,46 @@ An instance of ``GetDeepSearchResults`` has the following attributes:
 ``.bathrooms``
 ``.bedrooms``
 ``.brokerage``
+``.city``
+``.cooling_system``
 ``.elementary_school``
+``.exterior_material``
 ``.floor_material``
-``.graph_data_link``
 ``.heating_sources``
 ``.heating_system``
+``.high_school``
 ``.home_description``
 ``.home_detail_link``
 ``.home_info``
 ``.home_size``
 ``.home_type``
-``.last_sold_date``
-``.last_sold_price``
 ``.latitude``
 ``.longitude``
-``.map_this_home_link``
 ``.middle_school``
 ``.neighborhood``
 ``.num_floors``
 ``.num_rooms``
+``.page_view_count_this_month``
+``.page_view_count_total``
 ``.parking_type``
 ``.photo_gallery``
+``.posting_agent``
+``.posting_last_update``
+``.posting_mls``
 ``.posting_status``
 ``.posting_type``
+``.price``
 ``.property_size``
 ``.roof``
 ``.rooms``
 ``.school_district``
-``.tax_value``
-``.tax_year``
+``.state``
+``.street``
 ``.view``
 ``.year_built``
 ``.year_updated``
 ``.zillow_id``
+``.zipcode``
 
 Access the information by reading the ``GetUpdatedPropertyDetails`` object's attributes. For example:
 

pyzillow/__init__.py

@@ -1,3 +1,3 @@
 __author__ = "Hannes Hapke"
 __email__ = "hannes.hapke@gmail.com"
-__version__ = "0.6.1"
+__version__ = "0.7.0"