Install using pip:

pip install gargoyle-yplan

If you are upgrading from the original to this fork, you will need to run the following first, since the packages clash:

pip uninstall django-modeldict gargoyle

Failing to do this will mean that pip uninstall gargoyle will also erase the files for gargoyle-yplan, and similarly for our django-modeldict fork.

Enable Gargoyle

Once you’ve downloaded the Gargoyle package, you simply need to add it to your INSTALLED_APPS:


If you do not use Nexus, you will also need to enable discovery of modules (which contain ConditionSets). The best place to do this is within your file:

import gargoyle


If you do use files, Python 2.7, and the autodiscovery code, you’ll need to ensure your imports are not relative:

from __future__ import absolute_import

from gargoyle.conditions import ConditionSet

Nexus Frontend

While Gargoyle can be used without a frontend, we highly recommend using Nexus.

Nexus will automatically detect Gargoyle’s NexusModule, assuming its autodiscovery is on. If not, you will need to register the module by hand:

from gargoyle.nexus_modules import GargoyleModule, 'gargoyle')

Disabling Auto Creation

Under some conditions you may not want Gargoyle to automatically create switches that don’t currently exist. To disable this behavior, you may use the GARGOYLE_AUTO_CREATE setting your


Default Switch States

The GARGOYLE_SWITCH_DEFAULTS setting allows engineers to set the default state of a switch before it’s been added via the gargoyle admin interface. In your add something like:

    'new_switch': {
      'is_active': True,
      'label': 'New Switch',
      'description': 'When you want the newness',
    'funky_switch': {
      'is_active': False,
      'label': 'Funky Switch',
      'description': 'Controls the funkiness.',