Airavata Django Portal Commons

用于与动态加载的Django应用程序一起工作的工具。

入门

使用pip安装此软件包

pip install airavata-django-portal-commons

动态加载的Django应用程序

1. 在您的Django服务器settings.py文件的末尾添加以下内容：

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)

• 注意：如果动态Django应用程序使用WEBPACK_LOADER，请记住，django-webpack-loader和webpack-bundle-tracker的版本必须兼容。如果您使用的是版本1.0之前的django-webpack-loader，则已知的一对良好版本是django-webpack-loader==0.6.0和webpack-bundle-tracker==0.4.3。

2. 还将'airavata_django_portal_commons.dynamic_apps.context_processors.custom_app_registry'添加到context_processors列表中

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',
            ],
        },
    },
]

3. 在您的urls.py文件中，将以下内容添加到urlpatterns中

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

创建动态加载的Django应用程序

有关最新信息，请参阅 https://apache-airavata-django-portal.readthedocs.io/en/latest/dev/custom_django_app/

注意，默认情况下，cookiecutter模板 将Django应用程序注册在名为airavata.djangoapp的入口点组名下，但您可以更改它。只需确保在调用dynamic_apps.load时，将第二个参数传递为入口点组的名称。

开发

发布新版本

1. 更新setup.cfg中的版本。

2. 将更新提交到setup.cfg。

3. 使用相同的版本标记存储库，格式为v${version_number}。例如，如果setup.cfg中的版本号是"1.2"，则将存储库标记为"v1.2"。

   VERSION=...
   git tag -m $VERSION $VERSION
   git push --follow-tags
   

4. 在一个干净的检出中

   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
   

5. 推送到pypi.org。可选地可以推送到test.pypi.org。有关更多信息，请参阅 https://packaging.pythonlang.cn/tutorials/packaging-projects/

   python3 -m pip install --upgrade twine
   python3 -m twine upload dist/*