django-recipes 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+*.gemspec
+pkg/

data/Rakefile

@@ -0,0 +1,16 @@
+# Rakefile
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "django-recipes"
+    gemspec.summary = "Set of capistrano recipies for deploying django applications."
+    gemspec.description = "Set of capistrano recipies for deploying django applications."
+    gemspec.email = "Adman1965@gmail.com"
+    gemspec.homepage = "http://github.com/Adman65/django-recipes"
+    gemspec.authors = ["Adam Hawkins"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/django-recipes.rb

@@ -0,0 +1,4 @@
+require 'capistrano'
+require 'helpers'
+
+Dir.glob("#{File.dirname(__FILE__)}/recipes/**/*.rb").each { |file| load file }

data/lib/helpers.rb

@@ -0,0 +1,17 @@
+def app_path
+  "#{deploy_to}/#{application}"
+end
+
+def system_path
+  "#{deploy_to}/system"
+end
+
+def media_root_path
+  "#{deploy_to}/#{media_root}"
+end
+
+def render(template, binding)
+  require 'erb'
+  template = File.read("#{File.dirname(__FILE__)}/templates/#{template}.erb")
+  result = ERB.new(template).result(binding)
+end

data/lib/recipes/deploy.rb

@@ -0,0 +1,92 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do      
+    desc "Prepares system for deployment"  
+    task :setup, :roles => :app do
+      run "mkdir -p #{deploy_to}/system"
+      run "cd #{deploy_to}; git clone #{repository}"
+      create_upload_directories
+      make_system_writable
+      symlink
+      vhost
+    end  
+  
+    task :create_upload_directories, :roles => :app do
+      upload_directories.each do |dir|
+        run "mkdir -p #{system_path}/#{dir}"
+      end
+      make_system_writable
+    end
+  
+    desc "Deploys to an unitialized server"
+    task :cold, :roles => :app do
+      setup
+      syncdb
+      django #runs the deploy:django task
+    end
+  
+    desc "Deploy your django app"
+    task :django, :roles => :app do
+      disable
+      run "cd #{deploy_to}/#{application}; git pull"
+      reload
+      enable
+    end
+    
+    task :make_system_writable, :roles => :app do
+      run "chgrp -R #{apache_user} #{system_path}"
+      run "chmod -R g+wx #{system_path}"
+    end
+  
+    task :symlink, :roles => :app do
+       media_root_symlink
+       admin_symlink
+       system_symlink
+    end
+  
+    task :media_root_symlink, :roles => :app do
+      run "ln -sf #{app_path}/#{media_root} #{media_root_path}"   
+    end
+  
+    task :system_symlink, :roles => :app do
+      run "ln -sf #{system_path} #{media_root_path}/system"    
+    end
+  
+    task :admin_symlink, :roles => :app do
+      sudo "ln -sf #{django_path}/django/contrib/admin/media #{media_root_path}/#{admin_media_root}"
+    end
+  
+    desc "Creates a vhost for your application and uploads to server"
+    task :vhost, :roles => :app do    
+      put render('django_vhost.vhost',binding), "/tmp/#{vhost_name}"
+      sudo "mv /tmp/#{vhost_name} #{vhost_path}/#{vhost_name}"
+    end
+  
+    desc "Run django syncdb"
+    task :syncdb, :roles => :app do
+      run "cd #{app_path} ; ./manage.py syncdb --setting=#{settings}"
+    end
+  
+    desc "Destroys this app on the server"
+    task :destroy, :roles => :app do
+      run "rm -rf #{deploy_to}/*"
+      sudo "rm #{vhost_path}/#{vhost_name}"
+      reload
+    end  
+
+    desc "Reloads apache"
+    task :reload, :roles => :app do 
+      sudo "#{reload_cmd}"
+    end
+    
+    desc "Enables the website"
+    task :enable, :roles => :app do
+      run "rm #{system_path}/maintenance.html"
+    end
+  
+    desc "Disable the website"
+    task :disable, :roles => :app do
+      put render('maintenance.html',binding), "/tmp/maintenance.html"
+      run "mv /tmp/maintenance.html #{system_path}/maintenance.html"
+    end
+  end
+end

data/lib/recipes/django.rb

@@ -0,0 +1,8 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :django do
+    desc "Runs a command from manage.py"
+    task :run, :roles => :app do
+      run "cd #{app_path}; ./manage.py #{ENV['command']} --settings=#{settings}"
+    end
+  end
+end

data/lib/templates/django_vhost.vhost.erb

@@ -0,0 +1,25 @@
+<VirtualHost *:80>
+	ServerName <%= server_name %>
+	SetHandler python-program
+	PythonHandler django.core.handlers.modpython
+	SetEnv DJANGO_SETTINGS_MODULE <%= application %>.<%= settings %>
+	PythonPath "['<%= deploy_to %>/<%= application %>', '<%= deploy_to %>'] + sys.path"
+	PythonDebug Off
+	Alias /<%= media_root %> <%= media_root_path%>
+
+	<Directory "<%= deploy_to %>">
+		Options FollowSymLinks
+		Order deny,allow
+		Allow from all
+	</Directory>
+
+	<Location "/<%= media_root %>">
+		SetHandler None
+	</Location>
+	
+	RewriteEngine On
+	RewriteCond <%= system_path %>/maintenance.html -f
+	RewriteCond %{REQUEST_URI} !/<%= media_root %>/system/maintenance.html
+	RewriteRule $ /<%= media_root %>/system/maintenance.html [R=302,L]
+	
+</VirtualHost>

data/lib/templates/maintenance.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+	"http://www.w3.org/TR/html4/loose.dtd">
+<html>
+	<head>
+		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
+		<meta http-equiv="Content-Language" content="en-us">
+		<title>AFK, Out for a Drink</title>
+	</head>
+	<body>
+		<h1>Sorry, the site is down for maintenance.</h1>
+	</body>
+</html>
+	

data/readme.markdown

@@ -0,0 +1,165 @@
+# Django Recipes
+Django Recipes is a set of capistrano recipes created to automate deployment of simple Django powered websites. Once you've configured your capfile and server, you can go from no app, to running app.
+
+# Features
+	* One command deployment for setup servers: from no app to running app
+	* Maintenace Page
+	* Generated Vhost File
+	* Git based
+
+# Tasks
+	deploy:cold           # Deploys to an unitialized server (runs deploy:setup then deploy:django)
+	deploy:destroy        # Destroys this app on the server
+	deploy:django         # Deploy your django app
+	deploy:reload         # Reloads apache
+	deploy:syncdb         # Run django syncdb
+	deploy:vhost          # Creates a vhost for your application and uploads it
+	web:disable           # Disable the website
+	web:enable            # Enables the website	
+	
+# How it Works
+Capistrano uses ssh to connect to your server and create a directory structure. It uses this directory structure:
+
+	/+
+	 |- application
+	 |- system
+	 /+ media_root					# symlinked from media_root from application
+	 	|- system             # symlinked to the root level system
+		|- admin_media_root		# symlinked to django/contrib/admin/media
+	
+There is some Rails style going on here. Application is where your django code lives. System is a directory that survives through different deployments. You should use system for user file uploads and things like that. Your stylesheets, images, and javascript live in media_root. These folders are symlinked to create access for your webserver. 
+
+# Requirements
+Before you deploy your app, your server needs to be running apache and mod_python. If you are using Fedora you can use my [gem](http://github.com/Adman65/fedora) to make this process go very quickly. Django recipes assumes that you have a top level folder for your media root. Recapped:
+	
+	* Python, Apache, mod_python, and your DBMS installed
+	* User with sudo access (for linking to admin media)
+	* top level media directory
+	* ruby & rubygems installed
+
+# Setuping on Your Capfile
+Lets take an example application and the associated config file.
+
+## Application Structure
+	/mysite
+		/settings
+			production.py
+			development.py
+		/pictures
+		/avatars
+		/public							# media_root
+			/images
+			/stylesheets
+			/system
+				/pictures				# for uploaded pictures
+				/avatars				# for uploaded avatars
+		/templates
+		
+## Settings: production.py
+
+	# only relavent settings for deployment are included
+	MEDIA_ROOT = os.path.join(os.path.dirname(os.path.abspath(__file__)), "../public") # refers to /public because /settings/production.py
+	ADMIN_MEDIA_PREFIX = '/public/admin/'
+	MEDIA_URL = 'http://mydomain.com/public/'
+	
+## Capfile Configuration
+	
+	### SCM Setup ###
+	repository          # Git only
+	application         # Name of your project
+ 
+	### Deployment Settings ###
+	deploy_to           # this directory should already exist and the user should have control over it
+	apache_user         # name of apache user on your server
+	server_name         # for the ServerName entry in the vhost
+	vhost_name          # name of vhost to create
+	vhost_path          # location to put vhost file on your server (no trailing slash)
+	reload_cmd          # command to reload apache (ex: service httpd reload)
+ 
+	### Django Settings ###
+	django_path         # path to where django is installed. User for linking admin media
+	settings            # settings to use (must be specified)
+	upload_directories  # Array of directories to create in /system (must be an array)
+	
+	media_root          # corresponds to your MEDIA_ROOT
+	admin_media_root    # corresponds to your ADMIN_MEDIA_PREFIX
+	
+## The VHost Template
+
+	<VirtualHost *:80>
+		ServerName <%= server_name %>
+		SetHandler python-program
+		PythonHandler django.core.handlers.modpython
+		SetEnv DJANGO_SETTINGS_MODULE <%= application %>.<%= settings %>
+		PythonPath "['<%= deploy_to %>/<%= application %>', '<%= deploy_to %>'] + sys.path"
+		PythonDebug Off
+		Alias /<%= media_root %> <%= media_root_path%>
+
+		<Directory "<%= deploy_to %>">
+			Options FollowSymLinks
+			Order deny,allow
+			Allow from all
+		</Directory>
+
+		<Location "/<%= media_root %>">
+			SetHandler None
+		</Location>
+
+		RewriteEngine On
+		RewriteCond <%= system_path %>/maintenance.html -f
+		RewriteCond %{REQUEST_URI} !/<%= media_root %>/system/maintenance.html
+		RewriteRule $ /<%= media_root %>/system/maintenance.html [R=302,L]
+
+	</VirtualHost>
+	
+# Time to Deploy
+## Step 1:
+
+	# install ruby & ruby gems if you haven't done that already
+	gem install gemcutter
+	gem tumble
+	gem install capistrano
+	gem install django-recipes
+
+## Step 2: Capify
+
+	cd myproject
+	capify .
+	
+## Step 3: Prepare your cap file
+
+	require 'django-recipes'	# require django-recipes
+
+	### SSH Options ###
+	set :user, "deployer"		
+	default_run_options[:pty] = true
+
+	### SCM Setup ###
+	set :repository,  "git@github.com:Adman65/broadcastingadam.git"	# git only
+	set :application, "broadcastingadam"
+
+	### Servers Setup ###
+	role :web, "www.broadcastingadam.com"                          
+	role :app, "www.broadcastingadam.com"                          
+	role :db,  "www.broadcastingadam.com", :primary => true
+	role :db,  "www.broadcastingadam.com"
+
+	### Deployment Settings ###
+	set :deploy_to, "/var/www/html/www.broadcastingadam.com" #this directory should already exist and the user should have control over it
+	set :apache_user, "apache"
+	set :server_name, "broadcastingadam.com" #for the ServerName entry in the vhost
+	set :vhost_name, "#{server_name}.vhost"
+	set :vhost_path, "/etc/httpd/vhost.d" #no trailingslash
+	set :reload_cmd, "service httpd reload"
+
+	### Django Settings ###
+	set :django_path, "/usr/lib/python2.6/site-packages/Django-1.1.1-py2.6.egg"
+	set :settings, "settings.production"		# this example uses split settings, but you can just use settings like normal
+	set :upload_directories, ['covers','projects'] # must be an array
+
+	set :media_root, "public"
+	set :admin_media_root, "admin"
+	
+## Step 4: Deploy
+
+	cap deploy:cold

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: django-recipes
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adam Hawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-08 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Set of capistrano recipies for deploying django applications.
+email: Adman1965@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Rakefile
+- VERSION
+- lib/django-recipes.rb
+- lib/helpers.rb
+- lib/recipes/deploy.rb
+- lib/recipes/django.rb
+- lib/templates/django_vhost.vhost.erb
+- lib/templates/maintenance.html.erb
+- readme.markdown
+has_rdoc: true
+homepage: http://github.com/Adman65/django-recipes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Set of capistrano recipies for deploying django applications.
+test_files: []
+