django_root_path (optional): path to the directory
containing django project, relative to the
root of the repository (defaults to '.')
+ localsettings_dst_path (optional): path indicating
+ where to copy the localsettings file, relative
+ to django_root_path (defaults to project_name/localsettings.py)
+ skip_collect_static (optional): if True, Django collectstatic command is not called
"""
+from subprocess import check_output
from os.path import abspath, dirname, exists, join
from django.utils.crypto import get_random_string
from fabric.api import *
+from fabric.context_managers import settings
from fabric.contrib import files
from fabric.tasks import Task, execute
if not files.exists(env.app_path):
run('mkdir -p %(app_path)s' % env, pty=True)
with cd(env.app_path):
- for subdir in 'releases', 'packages', 'log':
+ for subdir in 'releases', 'packages', 'log', 'samples':
if not files.exists(subdir):
run('mkdir -p %s' % subdir, pty=True)
+ # Install helper manage.py script into root dir.
+ if not files.exists('manage.py'):
+ with settings(full_django_root=get_django_root_path('current')):
+ upload_sample('manage.py', where='', ext='', mode=0755)
with cd('%(app_path)s/releases' % env):
if not files.exists('current'):
run('ln -sfT . current', pty=True)
def check_localsettings():
- if not files.exists('%(app_path)s/localsettings.py' % env):
- abort('localsettings.py file missing.')
+ return files.exists('%(app_path)s/localsettings.py' % env)
@task(default=True)
require('hosts', 'app_path')
import time
- env.release = time.strftime('%Y-%m-%dT%H%M')
+ env.release = '%s_%s' % (time.strftime('%Y-%m-%dT%H%M'), check_output(['git', 'rev-parse', 'HEAD']).strip())
setup()
- check_localsettings()
+ if not check_localsettings():
+ abort('Setup is complete, but\n %(app_path)s/localsettings.py\n'
+ 'is needed for actual deployment.' % env)
upload_tar_from_git()
copy_localsettings()
install_requirements()
symlink_current_release()
migrate()
+ pre_collectstatic()
collectstatic()
restart()
@task
def restart():
- require('services')
- for service in env.services:
+ for service in env.services or ():
execute(service)
sudo('gunicorn-debian restart %s' % self.name, shell=False)
def upload_sample(self):
- upload_sample('gunicorn')
+ with settings(full_django_root=get_django_root_path('current')):
+ upload_sample('gunicorn')
class Apache(Service):
def run(self):
print '>>> supervisord: restart %s' % self.name
sudo('supervisorctl restart %s' % self.name, shell=False)
+class Command(Task):
+ def __init__(self, commands, working_dir):
+ if not hasattr(commands, '__iter__'):
+ commands = [commands]
+ self.name = 'Command: %s @ %s' % (commands, working_dir)
+ self.commands = commands
+ self.working_dir = working_dir
+
+ def run(self):
+ require('app_path')
+ with cd(join('%(app_path)s/releases/current' % env, self.working_dir)):
+ for command in self.commands:
+ run(command)
+
def upload_samples():
upload_localsettings_sample()
upload_nginx_sample()
for service in env.services:
service.upload_sample()
-def upload_sample(name):
+def upload_sample(name, where="samples/", ext='.sample', **kwargs):
require('app_path', 'project_name')
- upload_path = '%(app_path)s/' % env + name + '.sample'
+ upload_path = '%s/%s%s%s' % (env['app_path'], where, name, ext)
if files.exists(upload_path):
return
print '>>> upload %s template' % name
template = '%(project_name)s/' % env + name + '.template'
if not exists(template):
template = join(dirname(abspath(__file__)), 'templates/' + name + '.template')
- files.upload_template(template, upload_path, env)
+ files.upload_template(template, upload_path, env, **kwargs)
def upload_localsettings_sample():
"Fill out localsettings template and upload as a sample."
env.secret_key = get_random_string(50)
- upload_sample('localsettings.py')
+ upload_sample('localsettings.py', where="")
upload_nginx_sample = lambda: upload_sample('nginx')
require('app_path', 'project_name')
with settings(warn_only=True):
- copy_to = join(get_django_root_path(env['release']), env['project_name'])
+ copy_to = join(get_django_root_path(env['release']), env.get('localsettings_dst_path', env['project_name']))
run('cp %(app_path)s/localsettings.py ' % env + copy_to)
def symlink_current_release():
run('%(app_path)s/ve/bin/python manage.py syncdb --noinput' % env, pty=True)
run('%(app_path)s/ve/bin/python manage.py migrate' % env, pty=True)
+def pre_collectstatic():
+ print '>>> pre_collectstatic'
+ for task in env.get('pre_collectstatic', []):
+ execute(task)
+
def collectstatic():
"""Collect static files"""
print '>>> collectstatic'
+ if env.get('skip_collect_static', False):
+ print '... skipped'
+ return
require('app_path', 'project_name')
with cd(get_django_root_path('current')):
run('%(app_path)s/ve/bin/python manage.py collectstatic --noinput' % env, pty=True)
path = '%(app_path)s/releases/%(release)s' % dict(app_path = env['app_path'], release = release)
if 'django_root_path' in env:
path = join(path, env['django_root_path'])
- return path
\ No newline at end of file
+ return path