Aldlyn Addons Framework
aldryn-addons的Python项目详细描述
aldryn插件是可重用的django应用程序,遵循某些约定 从个人django网站中抽象出复杂的配置 投射到可升级的包中。用这种方法是可能的 为了避免重复“将这个添加到INSTALLED_APPS,将那个添加到 MIDDLEWARE_CLASSES并将它们添加到urls.py“工作中。设置逻辑 与插件捆绑在一起,只公开有趣的“meta”设置。 它是在django项目中使用此类插件的框架。
我们的目标是让django网站项目的足迹尽可能小 所以更新东西通常意味着在 requirements.txt并且项目中没有其他更改。
这个插件仍然使用传统的“aldryn”命名。你可以在我们的 support section。
贡献
这是一个开源项目。我们很高兴收到您的 以问题和请求的形式提供反馈。在提交您的 拉取请求,请查看我们的contribution guidelines。
我们感谢所有帮助创建和维护此软件包的贡献者。 贡献者列在contributors 区域
文档
请参阅setup.py中的REQUIREMENTS。 其他依赖项的文件:
安装
aldryn-addons是divio云平台的一部分。
对于手动安装:
将aldryn-addons添加到项目requirements.txt或pip安装它。 强烈建议安装aldryn-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_patterns:i18n_patterns('', ...
from django.conf.urls import url, 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 url(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
将其添加到INSTALLED_ADDONS中settings.py:
INSTALLED_ADDONS = [ 'aldryn-django', 'aldryn-cms', 'djangocms-link', ]
将aldryn_config.py和addon.json从加载项复制到addons 项目中的目录(addons/djangocms-link/aldryn_config.py和 addons/djangocms-link/addon.json)。如果aldryn_config.py定义了任何 设置窗体上的设置,将它们放入 addons/djangocms-link/settings.json,如果不将{}放入其中。
注意
需要手动复制aldryn_config.py和addon.json是 由于与Divio云平台的遗留兼容性,将不会 在以后的版本中需要更长的时间。
注意
未来的版本将包括一个带有图形用户界面的小web服务器 编辑settings.json中的设置,与提供的设置非常相似 在Divio云平台上。
你们都准备好了。aldryn_config.py中的代码将负责配置 那个插件。
运行测试
您可以执行以下操作来运行测试:
virtualenv env source env/bin/activate pip install -r tests/requirements.txt python setup.py test