examples/hammertime: a simple yet comprehensive example

japsu · japsu · commit db51d9ad18f6 · 2010-03-31T01:02:36.000+03:00
diff --git a/examples/hammertime/__init__.py b/examples/hammertime/__init__.py
diff --git a/examples/hammertime/anvil/__init__.py b/examples/hammertime/anvil/__init__.py
diff --git a/examples/hammertime/anvil/models.py b/examples/hammertime/anvil/models.py
@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.
diff --git a/examples/hammertime/anvil/tests.py b/examples/hammertime/anvil/tests.py
@@ -0,0 +1,23 @@
+"""
+This file demonstrates two different styles of tests (one doctest and one
+unittest). These will both pass when you run "manage.py test".
+
+Replace these 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.failUnlessEqual(1 + 1, 2)
+
+__test__ = {"doctest": """
+Another way to test that 1 + 1 is equal to 2.
+
+>>> 1 + 1 == 2
+True
+"""}
+
diff --git a/examples/hammertime/anvil/urls.py b/examples/hammertime/anvil/urls.py
@@ -0,0 +1,12 @@
+from django.conf.urls.defaults import *
+from django.views.generic.simple import direct_to_template
+
+from anvil.views import protected_resource
+
+urlpatterns = patterns('',
+    url(r'^$', direct_to_template, {'template':'index.html'}, name="index_page"),
+    url(r'^protected/$', protected_resource, name="protected_page"),
+
+    url(r'^accounts/login/$', 'django.contrib.auth.views.login', name="login_page"),
+    url(r'^accounts/logout/$', 'django.contrib.auth.views.logout', name="logout_page")
+)
diff --git a/examples/hammertime/anvil/views.py b/examples/hammertime/anvil/views.py
@@ -0,0 +1,10 @@
+# Create your views here.
+
+from django.shortcuts import render_to_response
+from django.contrib.auth.decorators import login_required
+from django.template import RequestContext
+
+@login_required
+def protected_resource(request):
+    return render_to_response("protected.html", context_instance=RequestContext(request, {}))
+
diff --git a/examples/hammertime/manage.py b/examples/hammertime/manage.py
@@ -0,0 +1,11 @@
+#!/usr/bin/python
+from django.core.management import execute_manager
+try:
+    import settings # Assumed to be in the same directory.
+except ImportError:
+    import sys
+    sys.stderr.write("Error: Can't find the file 'settings.py' in the directory containing %r. It appears you've customized things.\nYou'll have to run django-admin.py, passing it your settings module.\n(If the file settings.py does indeed exist, it's causing an ImportError somehow.)\n" % __file__)
+    sys.exit(1)
+
+if __name__ == "__main__":
+    execute_manager(settings)
diff --git a/examples/hammertime/settings.py.dist b/examples/hammertime/settings.py.dist
@@ -0,0 +1,96 @@
+# Django settings for hammertime project.
+import os
+
+DEBUG = True
+TEMPLATE_DEBUG = DEBUG
+
+ADMINS = (
+    # ('Your Name', 'your_email@domain.com'),
+)
+
+MANAGERS = ADMINS
+
+DATABASE_ENGINE = ''           # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
+DATABASE_NAME = ''             # Or path to database file if using sqlite3.
+DATABASE_USER = ''             # Not used with sqlite3.
+DATABASE_PASSWORD = ''         # Not used with sqlite3.
+DATABASE_HOST = ''             # Set to empty string for localhost. Not used with sqlite3.
+DATABASE_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.
+# If running in a Windows environment this must be set to the same as your
+# system time zone.
+TIME_ZONE = 'Europe/Helsinki'
+
+# 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
+
+# Absolute path to the directory that holds media.
+# Example: "/home/media/media.lawrence.com/"
+MEDIA_ROOT = ''
+
+# URL that handles the media served from MEDIA_ROOT. Make sure to use a
+# trailing slash if there is a path component (optional in other cases).
+# Examples: "http://media.lawrence.com", "http://example.com/media/"
+MEDIA_URL = ''
+
+# URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
+# trailing slash.
+# Examples: "http://foo.com/media/", "/media/".
+ADMIN_MEDIA_PREFIX = '/media/'
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = 'salainen'
+
+# List of callables that know how to import templates from various sources.
+TEMPLATE_LOADERS = (
+    'django.template.loaders.filesystem.load_template_source',
+    'django.template.loaders.app_directories.load_template_source',
+#     'django.template.loaders.eggs.load_template_source',
+)
+
+MIDDLEWARE_CLASSES = (
+    'django.middleware.common.CommonMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+)
+
+ROOT_URLCONF = 'urls'
+
+TEMPLATE_DIRS = (
+    os.path.abspath(os.path.join(os.path.dirname(__file__), "templates"))
+    # 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',
+)
+
+LOGIN_URL = '/hammertime/accounts/login'
+
+AUTHENTICATION_BACKENDS = (
+    ('django.contrib.auth.backends.ModelBackend'),
+    ('phpbb.auth.backends.PhpbbBackend'),
+)
+
+PHPBB_AUTH_DB_MODULE = "psycopg2"
+PHPBB_AUTH_DB_PARAMS = {
+    "user": "",
+    "password": "",
+    "database": "",
+}
+
diff --git a/examples/hammertime/templates/base.html b/examples/hammertime/templates/base.html
@@ -0,0 +1,11 @@
+<html>
+<head>
+<title>Hammertime!</title>
+</head>
+<body>
+<h1>Hammertime!</h1>
+{% block content %}
+<p>Content goes here.</p>
+{% endblock content %}
+</body>
+
diff --git a/examples/hammertime/templates/index.html b/examples/hammertime/templates/index.html
@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+{% block content %}
+<ul>
+<li><a href="{% url login_page %}">Log in</a></li>
+<li><a href="{% url protected_page %}">Access protected resource</a></li>
+<li><a href="{% url logout_page %}">Log out</a></li>
+</ul>
+{% endblock content %}
diff --git a/examples/hammertime/templates/protected.html b/examples/hammertime/templates/protected.html
@@ -0,0 +1,2 @@
+<p>Congratulations, {{ user.username }}! You are now accessing a protected resource!</p>
+<p>Remember to <a href="{% url logout_page %}">log out</a>.</p>
diff --git a/examples/hammertime/templates/registration/logged_out.html b/examples/hammertime/templates/registration/logged_out.html
@@ -0,0 +1,4 @@
+{% extends "base.html" %}
+{% block content %}
+<p>You have been logged out.</p>
+{% endblock content %}
diff --git a/examples/hammertime/templates/registration/login.html b/examples/hammertime/templates/registration/login.html
@@ -0,0 +1,25 @@
+{% extends "base.html" %}
+
+{% block content %}
+
+{% if form.errors %}
+<p>Your username and password didn't match. Please try again.</p>
+{% endif %}
+
+<form method="post" action="{% url django.contrib.auth.views.login %}">
+<table>
+<tr>
+    <td>{{ form.username.label_tag }}</td>
+    <td>{{ form.username }}</td>
+</tr>
+<tr>
+    <td>{{ form.password.label_tag }}</td>
+    <td>{{ form.password }}</td>
+</tr>
+</table>
+
+<input type="submit" value="login" />
+<input type="hidden" name="next" value="{{ next }}" />
+</form>
+
+{% endblock %}
diff --git a/examples/hammertime/urls.py b/examples/hammertime/urls.py
@@ -0,0 +1,18 @@
+from django.conf.urls.defaults import *
+
+# Uncomment the next two lines to enable the admin:
+# from django.contrib import admin
+# admin.autodiscover()
+
+urlpatterns = patterns('',
+    # Example:
+    # (r'^hammertime/', include('hammertime.foo.urls')),
+
+    # Uncomment the admin/doc line below and add 'django.contrib.admindocs' 
+    # to INSTALLED_APPS to enable admin documentation:
+    # (r'^admin/doc/', include('django.contrib.admindocs.urls')),
+
+    # Uncomment the next line to enable the admin:
+    # (r'^admin/', include(admin.site.urls)),
+    url(r'', include('anvil.urls'))
+)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from django.db import models`
	`2`	`+`
	`3`	`+# Create your models here.`