未提供项目描述
项目描述
ckanext-nswdesignsystem
使用NSW Design System为CKAN进行样式的工具集合
与核心CKAN版本的兼容性
CKAN版本 | 兼容? |
---|---|
2.9 | 不兼容 |
2.10 | 兼容 |
安装
要安装ckanext-nswdesignsystem
-
通过pip安装
pip install ckanext-nswdesignsystem
-
将
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 上可用,您可以按照以下步骤发布新版本
-
在
setup.cfg
文件中更新版本号。有关如何选择版本号的说明,请参阅 PEP 440。 -
确保您有必需软件包的最新版本
pip install -U twine build git-changelog -r dev-requirements.txt
-
更新更改日志
make changelog
-
创建新版本的源和二进制分发
python -m build
-
将源分发上传到 PyPI
twine upload dist/*
-
提交任何悬而未决的更改
git commit -a git push
-
使用来自
setup.cfg
文件的版本号在 GitHub 上标记项目的最新发布。例如,如果setup.cfg
中的版本号为 0.0.1,则执行以下操作git tag v0.0.1 git push --tags
许可证
项目详情
下载文件
下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。
源分发
构建分发
ckanext_nswdesignsystem-0.1.8.tar.gz 的散列
算法 | 散列摘要 | |
---|---|---|
SHA256 | 525fd515cc59eaa5b2ad165b3a41e596ec6bd9fbfeecddb99a210f10d84de903 |
|
MD5 | acee3beda4758a9ee2ce5562e5f880c1 |
|
BLAKE2b-256 | 3ec35fd55fed90c92d5449c98309c9d6dd9901deb1d15ff4a7a3929665a572ea |
ckanext_nswdesignsystem-0.1.8-py3-none-any.whl 的散列
算法 | 散列摘要 | |
---|---|---|
SHA256 | 8201074833a89c7282dec202efe05444ce5f089652bf598815a314a60cc79b61 |
|
MD5 | d7600ba2698ca8296376eac33cb937e6 |
|
BLAKE2b-256 | 17d0da1c2595d00a59e868b1e4d355b935f50793e18bfbca930077b325866bc9 |