Permalink
Browse files

first commit

  • Loading branch information...
0 parents commit ea7965f5a1c47b1e46a76b8023f89f430d0aa832 @amccloud committed Dec 23, 2011
5 .gitignore
@@ -0,0 +1,5 @@
+*.pyc
+*.pyo
+.DS_Store
+/local_settings.py
+/public
39 README.md
@@ -0,0 +1,39 @@
+# {{ project_name|title }} Django Project #
+## Prerequisites ##
+
+- python >= 2.5
+- pip
+- virtualenv/wrapper (optional)
+
+## Installation ##
+### Creating the environment ###
+Create a virtual python enviroment for the project.
+If you're not using virtualenv or virtualenvwrapper you may skip this step.
+
+#### For virtualenvwrapper ####
+```mkvirtualenv --no-site-packages {{ project_name }}-env```
+
+#### For virtualenv ####
+```virtualenv --no-site-packages {{ project_name }}-env
+cd {{ project_name }}-env
+source bin/activate```
+
+### Clone the code ###
+Obtain the url to your git repository.
+```git clone <URL_TO_GIT_RESPOSITORY> {{ project_name }}```
+
+### Install requirements ###
+```cd {{ project_name }}
+pip install -r requirements.txt```
+
+### Configure project ###
+```cp {{ project_name }}/__local_settings.py {{ project_name }}/local_settings.py
+vi {{ project_name }}/local_settings.py```
+
+### Sync database ###
+```./manage.py syncdb```
+
+## Running ##
+```./manage.py runserver```
+
+Open browser to 127.0.0.1:8000
8 manage.py
@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+import os, sys
+
+if __name__ == '__main__':
+ os.environ.setdefault('DJANGO_SETTINGS_MODULE', '{{ project_name }}.settings')
+
+ from django.core.management import execute_from_command_line
+ execute_from_command_line(sys.argv)
1 project_name/__init__.py
@@ -0,0 +1 @@
+# {% now "DATE_FORMAT" %}
20 project_name/__local_settings.py
@@ -0,0 +1,20 @@
+# Local settings for {{ project_name }} project.
+DEBUG = True
+
+DATABASES = {
+ 'default': {
+ 'ENGINE': 'django.db.backends.', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
+ 'NAME': '', # 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.
+ }
+}
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = '{{ secret_key }}'
+
+if DEBUG:
+ # Show emails in the console during developement.
+ EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
1 project_name/fixtures/.gitdirectory
@@ -0,0 +1 @@
+Placeholder so that this directory will be added to the git repository.
20 project_name/local_settings.py
@@ -0,0 +1,20 @@
+# Local settings for {{ project_name }} project.
+DEBUG = True
+
+DATABASES = {
+ 'default': {
+ 'ENGINE': 'django.db.backends.', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
+ 'NAME': '', # 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.
+ }
+}
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = '{{ secret_key }}'
+
+if DEBUG:
+ # Show emails in the console during developement.
+ EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
1 project_name/public/.gitdirectory
@@ -0,0 +1 @@
+Placeholder so that this directory will be added to the git repository.
159 project_name/settings.py
@@ -0,0 +1,159 @@
+# Global settings for {{ project_name }} project.
+import os
+
+PROJECT_DIR = os.path.dirname(__file__)
+PUBLIC_DIR = os.path.join(PROJECT_DIR, 'public')
+
+DEBUG = False
+TEMPLATE_DEBUG = True
+
+ADMINS = (
+ # ('Your Name', 'your_email@example.com'),
+)
+
+MANAGERS = ADMINS
+
+# 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.
+# On Unix systems, a value of None will cause Django to use the same
+# timezone as the operating system.
+# If running in a Windows environment this must be set to the same as your
+# system time zone.
+TIME_ZONE = 'UTC'
+
+# 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 = os.path.join(PUBLIC_DIR, 'media')
+
+# 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 = '/media/'
+
+# 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 = os.path.join(PUBLIC_DIR, 'static')
+
+# 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.
+ os.path.join(PROJECT_DIR, 'static'),
+)
+
+# 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',
+)
+
+# 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',
+)
+
+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',
+ 'django.middleware.clickjacking.XFrameOptionsMiddleware',
+)
+
+ROOT_URLCONF = '{{ project_name }}.urls'
+
+# Python dotted path to the WSGI application used by Django's runserver.
+WSGI_APPLICATION = '{{ project_name }}.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_DIR, 'templates'),
+)
+
+TEMPLATE_CONTEXT_PROCESSORS = (
+ 'django.contrib.auth.context_processors.auth',
+ 'django.contrib.messages.context_processors.messages',
+ 'django.core.context_processors.debug',
+ 'django.core.context_processors.i18n',
+ 'django.core.context_processors.media',
+ 'django.core.context_processors.static',
+ 'django.core.context_processors.request',
+)
+
+FIXTURE_DIRS = (
+ os.path.join(PROJECT_DIR, 'fixtures'),
+)
+
+INSTALLED_APPS = (
+ 'django.contrib.auth',
+ 'django.contrib.contenttypes',
+ 'django.contrib.sessions',
+ 'django.contrib.sites',
+ 'django.contrib.messages',
+ 'django.contrib.staticfiles',
+ 'django.contrib.admin',
+)
+
+# 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,
+ },
+ }
+}
+
+try:
+ from local_settings import *
+except ImportError:
+ pass
1 project_name/static/.gitdirectory
@@ -0,0 +1 @@
+Placeholder so that this directory will be added to the git repository.
1 project_name/templates/404.html
@@ -0,0 +1 @@
+<h1>404 - Not Found</h1>
1 project_name/templates/500.html
@@ -0,0 +1 @@
+<h1>500 - Server Error</h1>
10 project_name/templates/base.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+ <title></title>
+ </head>
+ <body>
+
+ </body>
+</html>
8 project_name/urls.py
@@ -0,0 +1,8 @@
+from django.conf.urls import patterns, include, url
+from django.contrib import admin
+
+admin.autodiscover()
+
+urlpatterns = patterns('',
+ url(r'^admin/', include(admin.site.urls)),
+)
28 project_name/wsgi.py
@@ -0,0 +1,28 @@
+"""
+WSGI config for {{ project_name }} 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", "{{ project_name }}.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)
1 requirements.txt
@@ -0,0 +1 @@
+django>=1.4

0 comments on commit ea7965f

Please sign in to comment.