Permalink
Browse files

Initial commit

  • Loading branch information...
0 parents commit e63b076f86d549790ed117bf439ae4ee57c40d10 @tomchristie committed Oct 26, 2012
@@ -0,0 +1,7 @@
+*.pyc
+*.db
+*~
+.*
+
+!.gitignore
+!.travis.yml
@@ -0,0 +1,5 @@
+# REST framework tutorial
+
+Source code for the [Django REST framework tutorial][tut].
+
+[tut]: http://tomchristie.github.com/django-rest-framework/tutorial/1-serialization
@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+ os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tutorial.settings")
+
+ from django.core.management import execute_from_command_line
+
+ execute_from_command_line(sys.argv)
No changes.
@@ -0,0 +1,31 @@
+from django.db import models
+from pygments.lexers import get_all_lexers, get_lexer_by_name
+from pygments.styles import get_all_styles
+from pygments.formatters import HtmlFormatter
+from pygments import highlight
+
+LEXER_CHOICES = sorted([(item[1][0], item[0]) for item in get_all_lexers()])
+STYLE_CHOICES = sorted((item, item) for item in list(get_all_styles()))
+
+
+class Snippet(models.Model):
+ owner = models.ForeignKey('auth.User', related_name='snippets')
+ title = models.CharField(max_length=100, default='')
+ code = models.TextField()
+ linenos = models.BooleanField(default=False)
+ language = models.CharField(choices=LEXER_CHOICES,
+ default='python',
+ max_length=100)
+ style = models.CharField(choices=STYLE_CHOICES,
+ default='friendly',
+ max_length=100)
+ highlighted = models.TextField()
+
+ def save(self, *args, **kwargs):
+ lexer = get_lexer_by_name(self.language)
+ linenos = self.linenos and 'table' or False
+ options = self.title and {'title': self.title} or {}
+ formatter = HtmlFormatter(style=self.style, linenos=linenos,
+ full=True, **options)
+ self.highlighted = highlight(self.code, lexer, formatter)
+ super(Snippet, self).save(*args, **kwargs)
@@ -0,0 +1,12 @@
+from rest_framework import permissions
+
+
+class IsOwnerOrReadOnly(permissions.BasePermission):
+ def has_permission(self, request, view, obj=None):
+ if obj is None:
+ return True
+
+ if request.method in permissions.SAFE_METHODS:
+ return True
+
+ return obj.owner == request.user
@@ -0,0 +1,9 @@
+from rest_framework import renderers
+
+
+class HTMLRenderer(renderers.BaseRenderer):
+ media_type = 'text/html'
+ format = 'html'
+
+ def render(self, data, accepted_media_type=None, renderer_context=None):
+ return data
@@ -0,0 +1,23 @@
+from snippets import models
+from django.contrib.auth.models import User
+from rest_framework import serializers
+
+
+class SnippetSerializer(serializers.HyperlinkedModelSerializer):
+ owner = serializers.HyperlinkedRelatedField(view_name='user-detail',
+ readonly=True)
+ highlight = serializers.HyperlinkedIdentityField(view_name='snippet-highlight')
+
+ class Meta:
+ model = models.Snippet
+ fields = ('url', 'highlight', 'owner',
+ 'title', 'code', 'linenos', 'language', 'style')
+
+
+class UserSerializer(serializers.HyperlinkedModelSerializer):
+ snippets = serializers.ManyHyperlinkedRelatedField(view_name='snippet-detail',
+ readonly=True)
+
+ class Meta:
+ model = User
+ fields = ('url', 'username', 'snippets')
@@ -0,0 +1,54 @@
+from snippets.models import Snippet
+from snippets.permissions import IsOwnerOrReadOnly
+from snippets.renderers import HTMLRenderer
+from snippets.serializers import SnippetSerializer, UserSerializer
+from rest_framework import generics, permissions
+from rest_framework.decorators import api_view
+from rest_framework.response import Response
+from rest_framework.reverse import reverse
+from django.contrib.auth.models import User
+
+
+@api_view(('GET',))
+def api_root(request):
+ return Response({
+ 'users': reverse('user-list', request=request),
+ 'snippets': reverse('snippet-list', request=request)
+ })
+
+
+class SnippetList(generics.ListCreateAPIView):
+ model = Snippet
+ serializer_class = SnippetSerializer
+ permission_classes = (permissions.IsAuthenticatedOrReadOnly,)
+
+ def pre_save(self, obj):
+ obj.owner = self.request.user
+
+
+class SnippetInstance(generics.RetrieveUpdateDestroyAPIView):
+ model = Snippet
+ serializer_class = SnippetSerializer
+ permission_classes = (permissions.IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly,)
+
+ def pre_save(self, obj):
+ obj.owner = self.request.user
+
+
+class SnippetHighlight(generics.SingleObjectAPIView):
+ model = Snippet
+ renderer_classes = (HTMLRenderer,)
+
+ def get(self, request, *args, **kwargs):
+ snippet = self.get_object()
+ return Response(snippet.highlighted)
+
+
+class UserList(generics.ListAPIView):
+ model = User
+ serializer_class = UserSerializer
+
+
+class UserInstance(generics.RetrieveAPIView):
+ model = User
+ serializer_class = UserSerializer
No changes.
@@ -0,0 +1,153 @@
+# Django settings for tutorial project.
+
+DEBUG = True
+TEMPLATE_DEBUG = DEBUG
+
+ADMINS = (
+ # ('Your Name', 'your_email@example.com'),
+)
+
+MANAGERS = ADMINS
+
+DATABASES = {
+ 'default': {
+ 'ENGINE': 'django.db.backends.sqlite3', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
+ 'NAME': 'tmp.db', # Or path to database file if using sqlite3.
+ 'USER': '', # Not used with sqlite3.
+ 'PASSWORD': '', # Not used with sqlite3.
+ 'HOST': '', # Set to empty string for localhost. Not used with sqlite3.
+ 'PORT': '', # Set to empty string for default. Not used with sqlite3.
+ }
+}
+
+# Local time zone for this installation. Choices can be found here:
+# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
+# although not all choices may be available on all operating systems.
+# In a Windows environment this must be set to your system time zone.
+TIME_ZONE = 'America/Chicago'
+
+# Language code for this installation. All choices can be found here:
+# http://www.i18nguy.com/unicode/language-identifiers.html
+LANGUAGE_CODE = 'en-us'
+
+SITE_ID = 1
+
+# If you set this to False, Django will make some optimizations so as not
+# to load the internationalization machinery.
+USE_I18N = True
+
+# If you set this to False, Django will not format dates, numbers and
+# calendars according to the current locale.
+USE_L10N = True
+
+# If you set this to False, Django will not use timezone-aware datetimes.
+USE_TZ = True
+
+# Absolute filesystem path to the directory that will hold user-uploaded files.
+# Example: "/home/media/media.lawrence.com/media/"
+MEDIA_ROOT = ''
+
+# URL that handles the media served from MEDIA_ROOT. Make sure to use a
+# trailing slash.
+# Examples: "http://media.lawrence.com/media/", "http://example.com/media/"
+MEDIA_URL = ''
+
+# Absolute path to the directory static files should be collected to.
+# Don't put anything in this directory yourself; store your static files
+# in apps' "static/" subdirectories and in STATICFILES_DIRS.
+# Example: "/home/media/media.lawrence.com/static/"
+STATIC_ROOT = ''
+
+# URL prefix for static files.
+# Example: "http://media.lawrence.com/static/"
+STATIC_URL = '/static/'
+
+# Additional locations of static files
+STATICFILES_DIRS = (
+ # Put strings here, like "/home/html/static" or "C:/www/django/static".
+ # Always use forward slashes, even on Windows.
+ # Don't forget to use absolute paths, not relative paths.
+)
+
+# List of finder classes that know how to find static files in
+# various locations.
+STATICFILES_FINDERS = (
+ 'django.contrib.staticfiles.finders.FileSystemFinder',
+ 'django.contrib.staticfiles.finders.AppDirectoriesFinder',
+# 'django.contrib.staticfiles.finders.DefaultStorageFinder',
+)
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = '98s9du5ruv!j%shx0udb#uz1g@v^xl65zm1l-_5%8cs6%c*qm$'
+
+# List of callables that know how to import templates from various sources.
+TEMPLATE_LOADERS = (
+ 'django.template.loaders.filesystem.Loader',
+ 'django.template.loaders.app_directories.Loader',
+# 'django.template.loaders.eggs.Loader',
+)
+
+MIDDLEWARE_CLASSES = (
+ 'django.middleware.common.CommonMiddleware',
+ 'django.contrib.sessions.middleware.SessionMiddleware',
+ 'django.middleware.csrf.CsrfViewMiddleware',
+ 'django.contrib.auth.middleware.AuthenticationMiddleware',
+ 'django.contrib.messages.middleware.MessageMiddleware',
+ # Uncomment the next line for simple clickjacking protection:
+ # 'django.middleware.clickjacking.XFrameOptionsMiddleware',
+)
+
+ROOT_URLCONF = 'tutorial.urls'
+
+# Python dotted path to the WSGI application used by Django's runserver.
+WSGI_APPLICATION = 'tutorial.wsgi.application'
+
+TEMPLATE_DIRS = (
+ # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
+ # Always use forward slashes, even on Windows.
+ # Don't forget to use absolute paths, not relative paths.
+)
+
+INSTALLED_APPS = (
+ 'django.contrib.auth',
+ 'django.contrib.contenttypes',
+ 'django.contrib.sessions',
+ 'django.contrib.sites',
+ 'django.contrib.messages',
+ 'django.contrib.staticfiles',
+ 'snippets',
+ 'rest_framework',
+)
+
+# A sample logging configuration. The only tangible logging
+# performed by this configuration is to send an email to
+# the site admins on every HTTP 500 error when DEBUG=False.
+# See http://docs.djangoproject.com/en/dev/topics/logging for
+# more details on how to customize your logging configuration.
+LOGGING = {
+ 'version': 1,
+ 'disable_existing_loggers': False,
+ 'filters': {
+ 'require_debug_false': {
+ '()': 'django.utils.log.RequireDebugFalse'
+ }
+ },
+ 'handlers': {
+ 'mail_admins': {
+ 'level': 'ERROR',
+ 'filters': ['require_debug_false'],
+ 'class': 'django.utils.log.AdminEmailHandler'
+ }
+ },
+ 'loggers': {
+ 'django.request': {
+ 'handlers': ['mail_admins'],
+ 'level': 'ERROR',
+ 'propagate': True,
+ },
+ }
+}
+
+REST_FRAMEWORK = {
+ 'PAGINATE_BY': 10
+}
@@ -0,0 +1,16 @@
+from snippets import views
+from django.conf.urls import patterns, url, include
+from rest_framework.urlpatterns import format_suffix_patterns
+
+urlpatterns = format_suffix_patterns(patterns('snippets.views',
+ url(r'^$', 'api_root'),
+ url(r'^snippets/$', views.SnippetList.as_view(), name='snippet-list'),
+ url(r'^snippets/(?P<pk>[0-9]+)/$', views.SnippetInstance.as_view(), name='snippet-detail'),
+ url(r'^snippets/(?P<pk>[0-9]+)/highlight/$', views.SnippetHighlight.as_view(), name='snippet-highlight'),
+ url(r'^users/$', views.UserList.as_view(), name='user-list'),
+ url(r'^users/(?P<pk>[0-9]+)/$', views.UserInstance.as_view(), name='user-detail')
+))
+
+urlpatterns += patterns('',
+ url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
+)
@@ -0,0 +1,28 @@
+"""
+WSGI config for tutorial project.
+
+This module contains the WSGI application used by Django's development server
+and any production WSGI deployments. It should expose a module-level variable
+named ``application``. Django's ``runserver`` and ``runfcgi`` commands discover
+this application via the ``WSGI_APPLICATION`` setting.
+
+Usually you will have the standard Django WSGI application here, but it also
+might make sense to replace the whole Django WSGI application with a custom one
+that later delegates to the Django one. For example, you could introduce WSGI
+middleware here, or combine a Django application with an application of another
+framework.
+
+"""
+import os
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tutorial.settings")
+
+# This application object is used by any WSGI server configured to use this
+# file. This includes Django's development server, if the WSGI_APPLICATION
+# setting points here.
+from django.core.wsgi import get_wsgi_application
+application = get_wsgi_application()
+
+# Apply WSGI middleware here.
+# from helloworld.wsgi import HelloWorldApplication
+# application = HelloWorldApplication(application)

0 comments on commit e63b076

Please sign in to comment.