Merge pull request #10 from ekonstantinidis/init-demo

Demo Project

Author: ekonstantinidis

.gitignore

@@ -3,3 +3,6 @@ __pycache__/
 
 env/
 djangorestframeworkdocs.egg-info/
+
+demo/env/
+demo/db.sqlite3

MANIFEST.in

@@ -1,7 +1,7 @@
 include README.md
 include LICENSE
 
-recursive-include drfdocs/static *.js *.css *.png *.eot *.svg *.ttf *.woff
-recursive-include drfdocs/templates *.html
+recursive-include rest_framework_docs/static *.js *.css *.less *.png *.eot *.svg *.ttf *.woff
+recursive-include rest_framework_docs/templates *.html
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

README.md

@@ -38,6 +38,9 @@ Finally include the `rest_framework_docs` urls in your `urls.py`:
         url(r'^docs/', include('rest_framework_docs.urls')),
     ]
 
+### Development & Demo Project
+Included in this repo you can find the demo project(at `/demo`). It is a project with *Django* & *Django Rest Framework* that will allow you to work with this project. For more information on how you can set it up please readme the [README.md](demo/README.md) of the demo project.
+
 ### Settings
 
     REST_FRAMEWORK_DOCS = {

demo/README.md

@@ -0,0 +1,27 @@
+## Setting up the demo project
+A demo project to get you started with DRF docs development.
+
+
+### Installation
+
+    # Create the virtual environment
+    pyvenv env
+
+    # Install requirements
+    env/bin/pip install -r requirements.txt
+
+    # Install Django Rest Framework Docs
+    env/bin/pip install -e ../
+
+    # Run the project
+    env/bin/python manage.py runserver
+
+**Note**: You **do not** need a database or to run `migrate`.
+
+
+### Viewing DRF Docs
+Once you install and run the project go to [http://0.0.0.0:8000/docs/](http://0.0.0.0:8000/docs/).
+
+
+### Note
+The demo project has no functionality at all. Its purpose is **only** for viewing the docs and developing DRF docs further.

demo/manage.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "project.settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

demo/project/__init__.py

@@ -0,0 +1,16 @@
+from django.db import models
+from django.contrib.auth.models import AbstractBaseUser
+
+
+class User(AbstractBaseUser):
+    created = models.DateTimeField(auto_now_add=True, db_index=True)
+    modified = models.DateTimeField(auto_now=True)
+
+    email = models.EmailField(unique=True, verbose_name='email address', max_length=255)
+    full_name = models.CharField(max_length=255)
+
+    is_active = models.BooleanField(default=False)
+    is_admin = models.BooleanField(default=False)
+
+    USERNAME_FIELD = 'email'
+    REQUIRED_FIELDS = ['email', 'full_name']

demo/project/accounts/__init__.py

@@ -0,0 +1,32 @@
+from rest_framework import serializers
+from project.accounts.models import User
+
+
+class UserRegistrationSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = User
+        fields = ('email', 'full_name', 'password',)
+        extra_kwargs = {'password': {'write_only': True}}
+
+
+class UserProfileSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = User
+        fields = ('email', 'full_name', 'password', 'is_active')
+        extra_kwargs = {
+            'password': {'write_only': True}
+        }
+        read_only_fields = ('is_active',)
+
+
+class ResetPasswordSerializer(serializers.ModelSerializer):
+
+    id = serializers.CharField()
+    token = serializers.CharField()
+
+    class Meta:
+        model = User
+        fields = ('id', 'token', 'password',)
+        extra_kwargs = {'password': {'write_only': True}}

demo/project/accounts/models.py

@@ -0,0 +1,15 @@
+from django.conf.urls import url
+from project.accounts import views
+
+
+urlpatterns = [
+    url(r'^test/$', views.TestView.as_view(), name="test-view"),
+
+    url(r'^login/$', views.LoginView.as_view(), name="login"),
+    url(r'^register/$', views.UserRegistrationView.as_view(), name="register"),
+    url(r'^reset-password/$', view=views.PasswordResetView.as_view(), name="reset-password"),
+    url(r'^reset-password/confirm/$', views.PasswordResetConfirmView.as_view(), name="reset-password-confirm"),
+
+    url(r'^user/profile/$', views.UserProfileView.as_view(), name="profile"),
+
+]