commit	2da373b2a4f78c1da9783ec1802e276cfc49beb0	[log] [tgz]
author	Marcus Christie <machristie@apache.org>	Tue Nov 01 12:28:47 2022 -0400
committer	Marcus Christie <machristie@apache.org>	Tue Nov 01 12:28:47 2022 -0400
tree	4c4549643a9d69f653b2e56700c3dec711a1d370
parent	15eed96dd874bbb25c7948388f8bbb62df5836af [diff]

tree: 4c4549643a9d69f653b2e56700c3dec711a1d370

README.md

Airavata Django Portal Commons

Utilities for working with dynamically loaded Django apps.

Getting Started

Install this package with pip

pip install airavata-django-portal-commons

Dynamically loaded Django apps

At the end of your Django server's settings.py file add

import sys
from airavata_django_portal_commons import dynamic_apps

# Add any dynamic apps installed in the virtual environment
dynamic_apps.load(INSTALLED_APPS)

# (Optional) merge WEBPACK_LOADER settings from custom Django apps
settings_module = sys.modules[__name__]
dynamic_apps.merge_settings(settings_module)

Also add 'airavata_django_portal_commons.dynamic_apps.context_processors.custom_app_registry' to the context_processors list:

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': ...
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                ...
                'airavata_django_portal_commons.dynamic_apps.context_processors.custom_app_registry',
            ],
        },
    },
]

In your urls.py file add the following to the urlpatterns

urlpatterns = [
    # ...
    path('', include('airavata_django_portal_commons.dynamic_apps.urls')),
]

Creating a dynamically loaded Django app

See https://apache-airavata-django-portal.readthedocs.io/en/latest/dev/custom_django_app/ for the latest information.

Note that by default the cookiecutter template registers Django apps under the entry_point group name of airavata.djangoapp, but you can change this. Just make sure that when you call dynamic_apps.load that you pass as the second argument the name of the entry_point group.