ckanext-nswdesignsystem

使用NSW Design System为CKAN进行样式的工具集合

与核心CKAN版本的兼容性

安装

要安装ckanext-nswdesignsystem

1. 通过pip安装

   pip install ckanext-nswdesignsystem
   

2. 将nswdesignsystem添加到您的CKAN配置文件中的ckan.plugins设置

用法

当插件启用时，访问应用程序的/nswdesignsystem/components URL。它列出了实现组件及其代码示例。

组件通常依赖于可以覆盖的宏，如果组件需要自定义，则可以覆盖。如果您需要组件的主要宏，请检查示例，然后查看宏源代码，以找出它使用的附加宏。

一些组件使用当前扩展中定义的辅助函数。通常这些是需要一些默认数据（例如链接或内容集合）的组件。例如，footer宏从nswdesignsystem_footer_links辅助函数获取upper、lower和social部分的链接。此类辅助函数应链式使用，以使用特定门户有意义的链接。

最后，一些宏（如masthead）可以作为函数使用

{{ masthead() }}

或使用call块

{% call masthead() %}
    {# additional content for masthead #}
{% endcall %}

最终，您可以覆盖宏/辅助/模板结构的相当低级别部分，因此始终关注更改日志。如果应用程序的任何部分有向后不兼容的更改，它将在此处提及。

配置设置

目前没有

开发

为了开发安装 ckanext-nswdesignsystem，激活您的 CKAN 虚拟环境并执行

git clone https://github.com/DataShades/ckanext-nswdesignsystem.git
cd ckanext-nswdesignsystem
pip install -e.

遵循 常规提交规范。具体来说

• 添加新功能的提交以： feat: <feature description(without angles)> 开始
• 修复 bug 的提交以： fix: <bug description(without angles)> 开始
• 对于不影响更改日志的任何内容： chore: <short message(without angles)>

测试

要运行测试，请执行

pytest

发布 ckanext-nswdesignsystem 的新版本

如果 ckanext-nswdesignsystem 应该在 PyPI 上可用，您可以按照以下步骤发布新版本

1. 在 setup.cfg 文件中更新版本号。有关如何选择版本号的说明，请参阅 PEP 440。

2. 确保您有必需软件包的最新版本

   pip install -U twine build git-changelog -r dev-requirements.txt
   

3. 更新更改日志

   make changelog
   

4. 创建新版本的源和二进制分发

   python -m build
   

5. 将源分发上传到 PyPI

   twine upload dist/*
   

6. 提交任何悬而未决的更改

   git commit -a
   git push
   

7. 使用来自 setup.cfg 文件的版本号在 GitHub 上标记项目的最新发布。例如，如果 setup.cfg 中的版本号为 0.0.1，则执行以下操作

   git tag v0.0.1
   git push --tags
   

许可证

AGPL