Fabric helpers

Core

Django

fusionbox.fabric.django.obfuscate()

Compile all source files to byte code, then remove them.

fusionbox.fabric.django.obfuscate_decorator(role)

Given a fabric action, this will run obfuscate() after it with config settings for the specified role.

fusionbox.fabric.django.run_subprocesses(*args, **kwds)

Returns a list of tuples of command, Popen object. During __close__, the list of processes is polled for unfinished processes and attempts to close them.

fusionbox.fabric.django.runserver()

Runs the local django server, starting up celery workers and/or the solr server if needed.

The following fb_env variables must be present in your fabfile for their related processes to be started. Each should be a 2-tuple of directory and command to run.

• runserver_cmd: ('.', './manage.py runserver')
• celery_cmd: ('.', './manage.py celery worker -c 2 --autoreload')
• solr_cmd: ('solr', 'java -jar start.jar')

fusionbox.fabric.django.shell()

Fires up a shell on the live server.

fusionbox.fabric.django.sync_db(role)

Downloads the latest remote (live or dev) database backup and loads it on your local machine.

fusionbox.fabric.django.sync_media(role)

Synchronizes the latest remote (live or dev) media directory with your local media directory.

FBORM

fusionbox.fabric.fborm.deploy()

Same as stage, but always uses the live branch and live config settings.

fusionbox.fabric.fborm.stage(branch=None, role='dev')

Updates the remote site files to your local branch head and migrates.

Utilities

fusionbox.fabric.utils.files_changed(version, files)

Checks if anything in files has changed between version and local HEAD.

fusionbox.fabric.utils.supervisor_command(action, name)

Performs a command on a supervisor process.

fusionbox.fabric.utils.virtualenv(*args, **kwds)

Context manager to run all commands under the python virtual env at dir.

Git utilities

fusionbox.fabric.git.get_git_branch()

Returns the name of the active local git branch.

fusionbox.fabric.git.has_git_branch(branch)

Checks if branch is available in the remote git repository.

fusionbox.fabric.git.is_local_repo_clean()

Checks if there are uncommitted changes in the local git repository.

fusionbox.fabric.git.is_repo_clean()

Checks if there are uncommitted changes in the remote git repository.

Update methods

fusionbox.fabric.update.get_update_function()

Returns the update function which will be used to update the remote site files based on the fb_env.transport_method config setting.

fusionbox.fabric.update.update_with_git(branch)

Updates the remote git repository to branch using git pull.

Returns the commit hash of the remote HEAD before it was updated.

fusionbox.fabric.update.update_with_rsync(branch)

Updates remote site files to local state of branch using rsync.

Returns the commit hash of remote version before update.