Merge pull request #129 from schbetsy/versions

Allow Flexible Library Versions

README.md

@@ -16,8 +16,8 @@ These instructions are for installation on a Mac with OS X Yosemite (version 10.
 * [Python 2.7](https://www.python.org/download/releases/2.7/)
 * [pip](https://pypi.python.org/pypi/pip)
 * [virtualenv](https://virtualenv.pypa.io/en/latest/)
-* [Django 1.8.15](https://docs.djangoproject.com/en/1.8/)
-* [Django Rest Framework 3.1.3](http://www.django-rest-framework.org)
+* [Django](https://docs.djangoproject.com/en/1.11/)
+* [Django Rest Framework](http://www.django-rest-framework.org)
 * [Django localflavor](https://github.com/django/django-localflavor)
 * [django-cors-headers](https://github.com/ottoyiu/django-cors-headers)
 
@@ -88,6 +88,25 @@ coverage run manage.py test
 coverage report
 ```
 
+
+## API Docs
+
+[Documentation](https://cfpb.github.io/owning-a-home-api/) for this repository is rendered via GitHub pages. They can be edited in the `docs/` directory, but to view or deploy them, you'll need to install the dependencies listed in the `docs_extras` section of `setup.py`:
+
+```
+pip install -e '.[docs]'
+```
+
+You can then preview your changes locally by running `mkdocs serve` and then reviewing <http://127.0.0.1:8000/>
+
+When your changes are ready, you can submit them as a normal pull request. After that, you can use this command to publish them:
+
+```
+mkdocs gh-deploy --clean
+```
+
+That pushes the necessary files to the `gh-pages` branch.
+
 ## Contributions
 
 We welcome contributions with the understanding that you are contributing to a project that is in the public domain, and anything you contribute to this project will also be released into the public domain. See our CONTRIBUTING file for more details.

setup.py

@@ -13,20 +13,25 @@ def read_file(filename):
 
 
 install_requires = [
-    'beautifulsoup4==4.5.3',
+    'beautifulsoup4>=4.5.0,<4.7',
     'Django>=1.8,<1.12',
     'django-cors-headers',
-    'dj-database-url==0.4.2',
+    'dj-database-url>=0.4.2,<1',
     'django-localflavor',
-    'djangorestframework==3.6.4', # Latest version that supports both Django 1.8 and 1.11
-    'requests>2.18,<2.20',
+    'djangorestframework==3.6.4',  # Latest version that supports both Django 1.8 and 1.11
+    'requests>=2.18,<3',
     'unicodecsv==0.14.1',
 ]
 
 testing_extras = [
-    'coverage==4.2',
+    'coverage>=4.5.1,<5',
     'mock==2.0.0',
-    'model_mommy==1.2.6',
+    'model_mommy>=1.6.0,<1.7',
+]
+
+docs_extras = [
+    'mkdocs==0.17.5',
+    'mkDOCter==1.0.5',
 ]
 
 
@@ -61,6 +66,7 @@ def read_file(filename):
     zip_safe=False,
     install_requires=install_requires,
     extras_require={
+        'docs': docs_extras,
         'testing': testing_extras,
     }
 )