commit	a631ee3e3ab5e9fee5d3b1afae632aae01cd826f	[log] [tgz]
author	Marcus Christie <machristie@apache.org>	Mon Jun 26 12:35:02 2023 -0400
committer	Marcus Christie <machristie@apache.org>	Mon Jun 26 12:35:02 2023 -0400
tree	18f4e6fec87b8102a8dd465ff33d70b08cea2354
parent	1bb6b2ab5f4273188e91cadc28c236a931042086 [diff]

tree: 18f4e6fec87b8102a8dd465ff33d70b08cea2354

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)

Note: if the dynamic Django app uses WEBPACK_LOADER, keep in mind that it is important that the version of django-webpack-loader and the version of webpack-bundle-tracker be compatible. If you're using django-webpack-loader prior to version 1.0 then a known good pair of versions is django-webpack-loader==0.6.0 and webpack-bundle-tracker==0.4.3.

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.

Developing

Making a new release

Update the version in setup.cfg.
Commit the update to setup.cfg.
Tag the repo with the same version, with the format v${version_number}. For example, if the version number in setup.cfg is “1.2” then tag the repo with “v1.2”.
```
VERSION=...
git tag -m $VERSION $VERSION
git push --follow-tags
```

In a clean checkout

cd /tmp/
git clone /path/to/airavata-django-portal-commons/ -b $VERSION
cd airavata-django-portal-commons
python3 -m venv venv
source venv/bin/activate
python3 -m pip install --upgrade pip build
python3 -m build

Push to pypi.org. Optionally can push to test.pypi.org. See https://packaging.python.org/tutorials/packaging-projects/ for more info.
```
python3 -m pip install --upgrade twine
python3 -m twine upload dist/*
```