diff options
| author | Tom Christie | 2013-11-18 09:29:22 +0000 | 
|---|---|---|
| committer | Tom Christie | 2013-11-18 09:29:22 +0000 | 
| commit | 4ddbeb1634481812cc12e0a839a2bd891d48b6a3 (patch) | |
| tree | 7ad654462d06707e9f80ed4b36b900b66cdb0d2a | |
| parent | 075b8c1037588a590360ab5290b25648367a26c5 (diff) | |
| parent | 6eeebea12be54f588cb3ce85623812f02470d02f (diff) | |
| download | django-rest-framework-4ddbeb1634481812cc12e0a839a2bd891d48b6a3.tar.bz2 | |
Merge branch 'master' of https://github.com/tomchristie/django-rest-framework
| -rw-r--r-- | README.md | 65 | ||||
| -rw-r--r-- | setup.cfg | 2 | ||||
| -rwxr-xr-x | setup.py | 1 | 
3 files changed, 37 insertions, 31 deletions
@@ -48,48 +48,51 @@ Let's take a look at a quick example of using REST framework to build a simple m  Here's our project's root `urls.py` module: -    from django.conf.urls.defaults import url, patterns, include -    from django.contrib.auth.models import User, Group -    from rest_framework import viewsets, routers +```python +from django.conf.urls.defaults import url, patterns, include +from django.contrib.auth.models import User, Group +from rest_framework import viewsets, routers -    # ViewSets define the view behavior. -    class UserViewSet(viewsets.ModelViewSet): -        model = User +# ViewSets define the view behavior. +class UserViewSet(viewsets.ModelViewSet): +    model = User -    class GroupViewSet(viewsets.ModelViewSet): -        model = Group +class GroupViewSet(viewsets.ModelViewSet): +    model = Group -    # Routers provide an easy way of automatically determining the URL conf -    router = routers.DefaultRouter() -    router.register(r'users', UserViewSet) -    router.register(r'groups', GroupViewSet) +# Routers provide an easy way of automatically determining the URL conf +router = routers.DefaultRouter() +router.register(r'users', UserViewSet) +router.register(r'groups', GroupViewSet) -    # Wire up our API using automatic URL routing. -    # Additionally, we include login URLs for the browseable API. -    urlpatterns = patterns('', -        url(r'^', include(router.urls)), -        url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) -    ) +# Wire up our API using automatic URL routing. +# Additionally, we include login URLs for the browseable API. +urlpatterns = patterns('', +    url(r'^', include(router.urls)), +    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) +) +```  We'd also like to configure a couple of settings for our API.  Add the following to your `settings.py` module: -    REST_FRAMEWORK = { -        # Use hyperlinked styles by default. -        # Only used if the `serializer_class` attribute is not set on a view. -        'DEFAULT_MODEL_SERIALIZER_CLASS': -            'rest_framework.serializers.HyperlinkedModelSerializer', - -        # Use Django's standard `django.contrib.auth` permissions, -        # or allow read-only access for unauthenticated users. -        'DEFAULT_PERMISSION_CLASSES': [ -            'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly' -        ] -    } - +```python +REST_FRAMEWORK = { +    # Use hyperlinked styles by default. +    # Only used if the `serializer_class` attribute is not set on a view. +    'DEFAULT_MODEL_SERIALIZER_CLASS': +        'rest_framework.serializers.HyperlinkedModelSerializer', + +    # Use Django's standard `django.contrib.auth` permissions, +    # or allow read-only access for unauthenticated users. +    'DEFAULT_PERMISSION_CLASSES': [ +        'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly' +    ] +} +```  Don't forget to make sure you've also added `rest_framework` to your `INSTALLED_APPS` setting.  That's it, we're done! diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 00000000..5e409001 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[wheel] +universal = 1 @@ -45,6 +45,7 @@ version = get_version('rest_framework')  if sys.argv[-1] == 'publish':      os.system("python setup.py sdist upload") +    os.system("python setup.py bdist_wheel upload")      print("You probably want to also tag the version now:")      print("  git tag -a %s -m 'version %s'" % (version, version))      print("  git push --tags")  | 
