跳转到主要内容

Aldryn Addons 框架

项目描述

pypi build coverage

Aldryn Addons是一组可重用的django应用,它们遵循某些约定,将复杂的配置从单个django网站项目抽象到可升级的包中。使用这种方法可以避免重复的“将此添加到INSTALLED_APPS,将那个添加到MIDDLEWARE_CLASSES,并将这些添加到urls.py”的工作。设置逻辑与插件捆绑在一起,并且只公开有趣的“元”设置。这是一个在django项目中利用此类插件的框架。

目标是尽可能减小在django网站项目中的足迹,因此更新事物通常只需在requirements.txt中增加版本号,而无需对项目进行其他更改。

此插件仍然使用传统的“Aldryn”命名。您可以在我们的支持部分了解更多信息。

贡献

这是一个开源项目。我们非常乐意收到您以问题和拉取请求形式提供的反馈。在提交您的拉取请求之前,请查看我们的贡献指南

我们感谢所有帮助创建和维护这个包的贡献者。贡献者名单在贡献者部分。

文档

setup.py文件中查看REQUIREMENTS以获取更多依赖项

python django

安装

aldryn-addons是Divio Cloud平台的一部分。

手动安装

aldryn-addons添加到您的项目的requirements.txt文件中,或者使用pip安装它。还强烈建议安装aldryn-django。这是将django本身捆绑为插件的django。

pip install aldryn-addons aldryn-django==1.6.11

settings.py的顶部添加以下代码片段

INSTALLED_ADDONS = [
    'aldryn-django',
]

# add your own settings here that are needed by the installed Addons

import aldryn_addons.settings
aldryn_addons.settings.load(locals())

# add any other custom settings here

插件可以自动将代码添加到根urls.py,因此需要添加aldryn_addons.urls.patterns()aldryn_addons.urls.i18n_patterns()。以下代码适用于Django 1.8及以上版本。对于Django的旧版本,请将前缀参数添加到i18n_patternsi18n_patterns('', ...

from django.urls import re_path, include
from django.conf.urls.i18n import i18n_patterns
import aldryn_addons.urls


urlpatterns = [
    # add your own patterns here
] + aldryn_addons.urls.patterns() + i18n_patterns(
    # add your own i18n patterns here
    re_path(r'^myapp/', include('myapp.urls')),
    *aldryn_addons.urls.i18n_patterns()  # MUST be the last entry!
)

请按照aldryn-django的安装说明进行完整集成。然后按照aldryn-django-cms的设置说明进行以下示例。

添加插件

在这个示例中,我们将安装django CMS Link,它需要Aldryn django CMS

使用pip安装插件

pip install djangocms-link

将其添加到settings.py中的INSTALLED_ADDONS

INSTALLED_ADDONS = [
    'aldryn-django',
    'aldryn-cms',
    'djangocms-link',
]

将插件中的aldryn_config.pyaddon.json复制到项目中的addons目录(addons/djangocms-link/aldryn_config.pyaddons/djangocms-link/addon.json)。如果aldryn_config.py在设置表单上定义了任何设置,请将它们放入addons/djangocms-link/settings.json中,如果没有,请将其放入{}中。

您已设置完毕。在aldryn_config.py中的代码将负责配置插件。

运行测试

您可以通过执行以下操作来运行测试

virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test

项目详情


下载文件

下载适合您平台文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分发

aldryn-addons-2.1.0.tar.gz (11.6 kB 查看哈希值)

上传时间

构建版本

aldryn_addons-2.1.0-py3-none-any.whl (10.7 kB 查看哈希值)

上传时间 Python 3

由以下支持