Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a bit more detailed django app example #176

Merged
merged 1 commit into from
Feb 28, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions examples/django_blogapp/REQUIREMENTS.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Django==1.5.4
argparse==1.2.1
couchdbkit==0.6.5
http-parser==0.8.3
restkit==4.2.2
socketpool==0.5.3
wsgiref==0.1.2
Empty file.
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
function(doc) {
if (doc.doc_type == "Post")
emit(doc._id, doc);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
function(doc) {
if (doc.doc_type == "Comment") {
emit(doc.post, doc);
}
}
17 changes: 17 additions & 0 deletions examples/django_blogapp/blog_app/models.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
from datetime import datetime

from couchdbkit.ext.django.schema import Document, StringProperty, \
DateTimeProperty


class Post(Document):
author = StringProperty()
title = StringProperty()
content = StringProperty()
date = DateTimeProperty(default=datetime.utcnow)

class Comment(Document):
author = StringProperty()
content = StringProperty()
date = DateTimeProperty(default=datetime.utcnow)
post = StringProperty()
16 changes: 16 additions & 0 deletions examples/django_blogapp/blog_app/tests.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
This file demonstrates writing tests using the unittest module. These will pass
when you run "manage.py test".
Replace this with more appropriate tests for your application.
"""

from django.test import TestCase


class SimpleTest(TestCase):
def test_basic_addition(self):
"""
Tests that 1 + 1 always equals 2.
"""
self.assertEqual(1 + 1, 2)
65 changes: 65 additions & 0 deletions examples/django_blogapp/blog_app/views.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
from couchdbkit.ext.django.forms import DocumentForm
from django.forms.fields import CharField
from django.forms.widgets import HiddenInput
from django.shortcuts import render_to_response
from django.template import RequestContext

from models import Post, Comment


class PostForm(DocumentForm):

class Meta:
document = Post

class CommentForm(DocumentForm):

post = CharField(widget=HiddenInput(), required=False)

class Meta:
document = Comment

def home(request):
post = None
form = PostForm(request.POST or None)

if request.POST:
if form.is_valid():
post = form.save()

posts = Post.view('blog_app/all_posts', descending=True)

return render_to_response("home.html", {
"form": form,
"post": post,
"posts": posts
}, context_instance=RequestContext(request))

def view_post(request, post_id):
post = Post.get(post_id)
form = CommentForm(request.POST or None)

if request.POST:
if form.is_valid():
form.cleaned_data['post'] = post_id
form.save()

comments = Comment.view('blog_app/commets_by_post', key=post_id)

return render_to_response("post_details.html", {
"form": form,
"post": post,
"comments": comments
}, context_instance=RequestContext(request))

def edit_post(request, post_id):
post = Post.get(post_id)
form = PostForm(request.POST or None, instance=post)

if form.is_valid():
post = form.save()

return render_to_response("post_edit.html", {
"form": form,
"post": post
}, context_instance=RequestContext(request))
168 changes: 168 additions & 0 deletions examples/django_blogapp/settings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
# Django settings for django_blogapp project.
import os

PROJECT_PATH = os.path.dirname(os.path.abspath(__file__))

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': 'test.db', # Or path to database file if using sqlite3.
# The following settings are not used with sqlite3:
'USER': '',
'PASSWORD': '',
'HOST': '', # Empty for localhost through domain sockets or '127.0.0.1' for localhost through TCP.
'PORT': '', # Set to empty string for default.
}
}

COUCHDB_DATABASES = (
('django_blogapp.blog_app', 'http://127.0.0.1:5984/blog_app'),
)

# Hosts/domain names that are valid for this site; required if DEBUG is False
# See https://docs.djangoproject.com/en/1.5/ref/settings/#allowed-hosts
ALLOWED_HOSTS = []

# 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/Argentina/Buenos_Aires'

# Language code for this installation. All choices can be found here:
# http://www.i18nguy.com/unicode/language-identifiers.html
LANGUAGE_CODE = 'es-AR'

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: "/var/www/example.com/media/"
MEDIA_ROOT = ''

# URL that handles the media served from MEDIA_ROOT. Make sure to use a
# trailing slash.
# Examples: "http://example.com/media/", "http://media.example.com/"
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: "/var/www/example.com/static/"
STATIC_ROOT = ''

# URL prefix for static files.
# Example: "http://example.com/static/", "http://static.example.com/"
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 = '2+mptb$5$p0-w!q6u4=6pt)mjrf6+u&26jr65-e!3ax+4fo#r*'

# 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 = 'django_blogapp.urls'

# Python dotted path to the WSGI application used by Django's runserver.
WSGI_APPLICATION = 'django_blogapp.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.
os.path.join(PROJECT_PATH, 'templates'),
)

INSTALLED_APPS = (
'couchdbkit.ext.django',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.messages',
'django.contrib.staticfiles',
# Uncomment the next line to enable the admin:
# 'django.contrib.admin',
# Uncomment the next line to enable admin documentation:
# 'django.contrib.admindocs',
'django_blogapp.blog_app',
)

SESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer'

# 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,
},
}
}
16 changes: 16 additions & 0 deletions examples/django_blogapp/templates/base.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>Super Blog Application</title>
</head>
<body>
<header id="top">
<h1>Blog app</h1>
</header>

{% block content %}{% endblock %}

<footer></footer>
</body>
</html>
28 changes: 28 additions & 0 deletions examples/django_blogapp/templates/home.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{% extends "base.html" %}
{% load i18n %}

{% block content %}
<h2>Create new Post</h2>
<form method="post">
<table>
{{ form.as_table }}
</table>
{% csrf_token %}
<input type="submit" id="submit" value="submit">
</form>

{% if post %}
{{ post.get_id }} was added
{% endif %}
<hr />
<h2>Posts</h2>
<table>
{% for p in posts %}
<tr>
<td>{{ p.date|timesince }} ago.</td>
<td> by {{ p.author }} </td>
<td><a href="{% url 'django_blogapp.blog_app.views.view_post' p.get_id %}">{{ p.title }}</a></td>
</tr>
{% endfor %}
</table>
{% endblock content %}
38 changes: 38 additions & 0 deletions examples/django_blogapp/templates/post_details.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{% extends "base.html" %}
{% load i18n %}

{% block content %}
<h2>{{ post.title }}</h2>
<h4>by {{ post.author }}</h4>
<p>{{ post.content }}</p>
<br />
<p>Posted {{ post.date|timesince }} ago.</p>

<hr />

<h3><a href="{% url 'django_blogapp.blog_app.views.edit_post' post.get_id %}">Edit Post</a></h3>

<hr />

<h3>Comments</h3>

<table>
{% for c in comments %}
<tr>
<td>{{ c.author }}: </td>
<td>{{ c.content }}</td>
<td> {{ c.date|timesince }} ago.</td>
</tr>
{% endfor %}
</table>

<h4>Leave a comment!</h4>
<form method="post">
<table>
{{ form.as_table }}
</table>
{% csrf_token %}
<input type="submit" id="submit" value="submit">
</form>

{% endblock content %}
13 changes: 13 additions & 0 deletions examples/django_blogapp/templates/post_edit.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{% extends "base.html" %}
{% load i18n %}

{% block content %}
<h2>Editing Post {{ post.title }}</h2>
<form method="post">
<table>
{{ form.as_table }}
</table>
{% csrf_token %}
<input type="submit" id="submit" value="submit">
</form>
{% endblock content %}