Issue 410 (#411)

* Make documented example runserver work

Resolves #410: docs/getting-started.md example doesn't work.

* xGet the steps right in the documentation to run the example app.

* First attempt at for issue #410 didn't have includes sorted properly.

- travis caught it. This time I've done the isort locally to confirm the order.
- MIDDLEWARE_CLASSES was replaced by MIDDLEWARE as of Django 1.10 and, according to
  tox.ini, this is only testing >=1.11.

* missed a line which flake8 caught

* add back install of this package

* add myself as an author as requested

Author: n2ygk

AUTHORS

@@ -1,5 +1,6 @@
 Adam Wróbel <https://adamwrobel.com>
 Adam Ziolkowski <adam@adsized.com>
+Alan Crosswell <alan@columbia.edu>
 Christian Zosel <https://zosel.ch>
 Greg Aker <greg@gregaker.net>
 Jamie Bliss <astronouth7303@gmail.com>

docs/getting-started.md

@@ -70,13 +70,18 @@ From Source
 
     git clone https://github.com/django-json-api/django-rest-framework-json-api.git
     cd django-rest-framework-json-api
-    pip install -e .
+    python -m venv env
+    source env/bin/activate
     pip install -r example/requirements.txt
-    django-admin.py runserver
+	pip install -e .
+    django-admin.py startproject example .
+    python manage.py migrate
+    python manage.py runserver
 
 Browse to http://localhost:8000
 
 ## Running Tests
 
-    python runtests.py
+    pip install tox
+    tox
 

example/requirements.txt

@@ -1,2 +1,13 @@
 # Requirements specifically for the example app
 packaging
+Django>=1.11
+django-debug-toolbar
+django-polymorphic>=2.0
+djangorestframework
+inflection
+pluggy
+py
+pyparsing
+pytz
+six
+sqlparse

example/settings/dev.py

@@ -59,7 +59,7 @@
 
 PASSWORD_HASHERS = ('django.contrib.auth.hashers.UnsaltedMD5PasswordHasher', )
 
-MIDDLEWARE_CLASSES = (
+MIDDLEWARE = (
     'debug_toolbar.middleware.DebugToolbarMiddleware',
 )
 

example/urls.py

@@ -3,25 +3,47 @@
 from rest_framework import routers
 
 from example.views import (
+    AuthorRelationshipView,
     AuthorViewSet,
+    BlogRelationshipView,
     BlogViewSet,
+    CommentRelationshipView,
     CommentViewSet,
     CompanyViewset,
+    EntryRelationshipView,
     EntryViewSet,
+    NonPaginatedEntryViewSet,
     ProjectViewset
 )
 
 router = routers.DefaultRouter(trailing_slash=False)
 
 router.register(r'blogs', BlogViewSet)
 router.register(r'entries', EntryViewSet)
+router.register(r'nopage-entries', NonPaginatedEntryViewSet, 'nopage-entry')
 router.register(r'authors', AuthorViewSet)
 router.register(r'comments', CommentViewSet)
 router.register(r'companies', CompanyViewset)
 router.register(r'projects', ProjectViewset)
 
 urlpatterns = [
     url(r'^', include(router.urls)),
+    url(r'^entries/(?P<entry_pk>[^/.]+)/suggested/',
+        EntryViewSet.as_view({'get': 'list'}),
+        name='entry-suggested'
+        ),
+    url(r'^entries/(?P<pk>[^/.]+)/relationships/(?P<related_field>\w+)',
+        EntryRelationshipView.as_view(),
+        name='entry-relationships'),
+    url(r'^blogs/(?P<pk>[^/.]+)/relationships/(?P<related_field>\w+)',
+        BlogRelationshipView.as_view(),
+        name='blog-relationships'),
+    url(r'^comments/(?P<pk>[^/.]+)/relationships/(?P<related_field>\w+)',
+        CommentRelationshipView.as_view(),
+        name='comment-relationships'),
+    url(r'^authors/(?P<pk>[^/.]+)/relationships/(?P<related_field>\w+)',
+        AuthorRelationshipView.as_view(),
+        name='author-relationships'),
 ]