Streamline Server Deployments with Python Fabric in 10 Minutes

Previously I used rsync to sync code to the server, which works for occasional deployments but becomes cumbersome when deploying ten times a day. I explored Fabric, a Python‑based deployment tool that runs remote commands locally without logging into the server.

Fabric allows you to write a short Python script (fabfile.py) placed in the project directory. The script defines two tasks, pack and deploy, which create a tarball, upload it, extract it, set permissions, update a symlink, and restart the FastCGI service.

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from datetime import datetime
from fabric.api import *

env.user = 'root'
env.hosts = ['www.example.com']

def pack():
    'Define a pack task'
    tar_files = ['*.py', 'static/*', 'templates/*', 'favicon.ico']
    local('rm -f example.tar.gz')
    local('tar -czvf example.tar.gz --exclude=\'*.tar.gz\' --exclude=\'fabfile.py\' %s' % ' '.join(tar_files))

def deploy():
    'Define a deploy task'
    remote_tmp_tar = '/tmp/example.tar.gz'
    tag = datetime.now().strftime('%y.%m.%d_%H.%M.%S')
    run('rm -f %s' % remote_tmp_tar)
    put('shici.tar.gz', remote_tmp_tar)
    remote_dist_dir = '/srv/www.example.com@%s' % tag
    remote_dist_link = '/srv/www.example.com'
    run('mkdir %s' % remote_dist_dir)
    with cd(remote_dist_dir):
        run('tar -xzvf %s' % remote_tmp_tar)
    run('chown -R www-data:www-data %s' % remote_dist_dir)
    run('rm -f %s' % remote_dist_link)
    run('ln -s %s %s' % (remote_dist_dir, remote_dist_link))
    run('chown -R www-data:www-data %s' % remote_dist_link)
    fcgi = '/etc/init.d/py-fastcgi'
    with settings(warn_only=True):
        run('%s stop' % fcgi)
    run('%s start' % fcgi)

After defining the tasks, deployment is as simple as running fab pack and fab deploy. Fabric’s most common APIs are local() for local commands, run() for remote execution, and put() for file transfer; you can change directories on the remote host with with cd(...):.

By default Fabric aborts on command failure, but you can allow failures to continue using with settings(warn_only=True):. All operations are performed over SSH, making them secure, and password‑less SSH keys can be configured for smoother automation.

For team projects, Fabric can be combined with version control to automatically check out code, run tests, package, and deploy. Since Fabric executes ordinary Linux commands, it works well for interpreted languages like Python, Ruby, or PHP, though deploying compiled languages such as Java or C# may require additional build steps.