archival.ArchiveBox/archivebox/abx/hookspec_django_settings.py

from .hookspec import hookspec


###########################################################################################

@hookspec
def get_INSTALLED_APPS():
    """Return a list of apps to add to INSTALLED_APPS"""
    # e.g. ['your_plugin_type.plugin_name']
    return []

@hookspec
def register_INSTALLED_APPS(INSTALLED_APPS):
    """Mutate INSTALLED_APPS in place to add your app in a specific position"""
    # idx_of_contrib = INSTALLED_APPS.index('django.contrib.auth')
    # INSTALLED_APPS.insert(idx_of_contrib + 1, 'your_plugin_type.plugin_name')
    pass


@hookspec
def get_TEMPLATE_DIRS():
    return []     # e.g. ['your_plugin_type/plugin_name/templates']

@hookspec
def register_TEMPLATE_DIRS(TEMPLATE_DIRS):
    """Install django settings"""
    # e.g. TEMPLATE_DIRS.insert(0, 'your_plugin_type/plugin_name/templates')
    pass


@hookspec
def get_STATICFILES_DIRS():
    return []     # e.g. ['your_plugin_type/plugin_name/static']

@hookspec
def register_STATICFILES_DIRS(STATICFILES_DIRS):
    """Mutate STATICFILES_DIRS in place to add your static dirs in a specific position"""
    # e.g. STATICFILES_DIRS.insert(0, 'your_plugin_type/plugin_name/static')
    pass


@hookspec
def get_MIDDLEWARE():
    return []     # e.g. ['your_plugin_type.plugin_name.middleware.YourMiddleware']

@hookspec
def register_MIDDLEWARE(MIDDLEWARE):
    """Mutate MIDDLEWARE in place to add your middleware in a specific position"""
    # e.g. MIDDLEWARE.insert(0, 'your_plugin_type.plugin_name.middleware.YourMiddleware')
    pass


@hookspec
def get_AUTHENTICATION_BACKENDS():
    return []     # e.g. ['django_auth_ldap.backend.LDAPBackend']

@hookspec
def register_AUTHENTICATION_BACKENDS(AUTHENTICATION_BACKENDS):
    """Mutate AUTHENTICATION_BACKENDS in place to add your auth backends in a specific position"""
    # e.g. AUTHENTICATION_BACKENDS.insert(0, 'your_plugin_type.plugin_name.backend.YourBackend')
    pass

@hookspec
def get_DJANGO_HUEY_QUEUES():
    return []     # e.g. [{'name': 'your_plugin_type.plugin_name', 'HUEY': {...}}]

@hookspec
def register_DJANGO_HUEY(DJANGO_HUEY):
    """Mutate DJANGO_HUEY in place to add your huey queues in a specific position"""
    # e.g. DJANGO_HUEY['queues']['some_queue_name']['some_setting'] = 'some_value'
    pass


@hookspec
def get_ADMIN_DATA_VIEWS_URLS():
    return []

@hookspec
def register_ADMIN_DATA_VIEWS(ADMIN_DATA_VIEWS):
    """Mutate ADMIN_DATA_VIEWS in place to add your admin data views in a specific position"""
    # e.g. ADMIN_DATA_VIEWS['URLS'].insert(0, 'your_plugin_type/plugin_name/admin_data_views.py')
    pass


@hookspec
def register_settings(settings):
    """Mutate settings in place to add your settings / modify existing settings"""
    # settings.SOME_KEY = 'some_value'
    pass