An interactive tutorial that guides you through creating your first Django project. This notebook goes along with Chander Ganesan's Introduction to Django from Pycon 2012.
Additional materials for the tutorial include:
Please click play on the video below and follow along with the slides. You cannot see what Ganesan is doing in the video so only the audio is useful. It’s helpful to have his dialogue as you move through his tutorial.
In [1]:
from IPython.display import YouTubeVideo
YouTubeVideo('hp5ymCrD9yw')
Out[1]:
First make sure you have Django Installed or install it using pip install Django. Test the installation with the code below:
In [2]:
import django
print django.VERSION
In [3]:
# uncomment the line below when running for the first time.
#!django-admin.py startproject tutorial
In [43]:
cd tutorial
In [44]:
ls
'init.py' : A file that causes Python to treat the directory as a package.
manage.py: A command line utility to communicate with Django.
settings.py: Configuration settings for the project.
urls.py: URL declarations for the project. The URL's tell Django what to do when certain URL's are put into the browser
The command line experssion:
manage.py runserver
starts a server that runs on local host http://127.0.0.1:8000/ for development. To keep our notebook interactive, lets run our development server as a subprocess, so it can run in the background as we continue to develop our site. After clicking this link, http://127.0.0.1:8000/, you should see the dev server in your browser (Make sure to open a new tab). Whenever you make changes to your server it will autorestart and so it supports iterative dev process. To make things easy, we will include the comman to open the server as a background process in a function called dev_sever so that we can call it with ease later in the notebook.
In [34]:
class dev_server(object):
def __init__(self):
self.server = 'no_server'
def start(self):
'''
starts the server
'''
import subprocess
self.server = subprocess.Popen(["python", "manage.py", "runserver"])
print "Im running!"
def end(self):
'''
ends the sever
'''
if self.server == 'no_server':
print "there is no sever!"
else:
self.server.terminate()
print "I've Stopped."
In [35]:
dev_server = dev_server() # instantiate our object
In [39]:
dev_server.start()
In [11]:
#Uncomment to run for the first time, to create your first app hello_world
#!manage.py startapp hello_world
In [52]:
# save and overwrite the file. After you add Hello_world to the installed_apps method, execute the cell and it will save by using the code below.
%%writefile settings.py
# Django settings for mysite project.
DEBUG = True
TEMPLATE_DEBUG = DEBUG
ADMINS = (
# ('Your Name', 'your_email@example.com'),
)
MANAGERS = ADMINS
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
'NAME': '', # 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.
}
}
# 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/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: "/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 = 'x&0!-(kxytngyi%d1190w18^6!vmsdfsob6oswzl^hj9qcv0ux'
# 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 = 'mysite.urls'
# Python dotted path to the WSGI application used by Django's runserver.
WSGI_APPLICATION = 'mysite.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',
'django.contrib.hello_world', #<--- here is our new added app!!!!!!!!!!!
# Uncomment the next line to enable the admin:
# 'django.contrib.admin',
# Uncomment the next line to enable admin documentation:
# 'django.contrib.admindocs',
)
# 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,
},
}
}
If it runs, we did it!
In [53]:
dev_server.start()
In [54]:
%%writefile urls.py
from django.conf.urls.defaults import patterns, include, url
# Uncomment the next two lines to enable the admin:
# from django.contrib import admin
# admin.autodiscover()
urlpatterns = patterns( '' ,
url(r '^hello_world/' , include( 'tutorial.hello_world.urls' )),
url(r '^$' , 'tutorial.hello_world.views.welcome' ,name= 'hello_world-welcome' ),
#url(r'^(?P<name>.[^/]+)/(?P<age>\d+)/$', 'welcome', name='hello_world-welcome-name-age'),
# Examples:
# url(r'^$', 'tutorial.views.home', name='home'),
# url(r'^tutorial/', include('tutorial.foo.urls')),
# Uncomment the admin/doc line below to enable admin documentation:
# url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
# Uncomment the next line to enable the admin:
# url(r'^admin/', include(admin.site.urls)),
)
Create a new view in our Hello_World App
In [59]:
cd hello_world
In [60]:
ls
In [61]:
%%writefile test.py
#Iam a test
In [62]:
%%writefile views.py
# Create your views here.
from django.http import HttpResponse, HttpResponseForbidden
def welcome(request, name=None, age=None):
if name:
# The URL pattern matches only numbers, so we're not handling the
# ValueError that might happen if age isn't a numeric value.
if not age or int(age) < 18:
return HttpResponseForbidden( 'Grow up!' )
response=HttpResponse()
# Here we treat the response as a file-like object.
response.write( "Hi %s, are you %s?" % (name,age,))
# Here we just set a silly header (though a valid HTTP header
# would be just as applicable!)
response[ 'X-python-header' ]= 'That parrot is definitely dead.'
return response
else:
# Here we pass it a string
return HttpResponse( 'Hello!' )
# Here we pass it a generator (just as an example)
return HttpResponse(( '<br>%d' % (i) for i in xrange(1,1000)))
Check out our new view by using !manage.py runserver and going to http://127.0.0.1:8000/
In [66]:
cd ..
In [ ]:
In [63]:
cd C:\Users\Andrew\Documents\Kaggle\tutorial\django_tut
In [64]:
!git add django_tut.ipynb
In [65]:
!git commit
In [ ]: