ckanext-wysiwyg

待办事项： 在此处放置您扩展的描述：它做什么？它有哪些功能？请考虑包括一些截图或嵌入视频！

需求

待办事项： 例如，您可能想在这里提到这个扩展与哪些版本的CKAN兼容。

如果您的扩展可以跨不同版本工作，您可以添加以下表格

与核心CKAN版本的兼容性

建议值

• "是"
• "未测试" - 我想不出它为什么不会工作
• "尚未" - 有使其工作的意图
• "否"

安装

待办事项： 将任何其他安装步骤添加到以下列表中。例如，安装任何非Python依赖项或添加任何必需的配置设置。

要安装ckanext-wysiwyg

1. 激活您的CKAN虚拟环境，例如

   . /usr/lib/ckan/default/bin/activate

2. 克隆源并将其安装到虚拟环境

   git clone https://github.com//ckanext-wysiwyg.git cd ckanext-wysiwyg pip install -e . pip install -r requirements.txt

3. 将 wysiwyg 添加到您的CKAN配置文件中的 ckan.plugins 设置（默认配置文件位于 /etc/ckan/default/ckan.ini）。

4. 重启CKAN。例如，如果您在Ubuntu上使用Apache部署了CKAN

   sudo service apache2 reload

配置设置

目前没有

待办事项： 在此处记录任何可选配置设置。例如

# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.wysiwyg.some_setting = some_default_value

开发者安装

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

git clone https://github.com//ckanext-wysiwyg.git
cd ckanext-wysiwyg
python setup.py develop
pip install -r dev-requirements.txt

测试

要运行测试，请执行

pytest --ckan-ini=test.ini

发布 ckanext-wysiwyg 的新版本

如果 ckanext-wysiwyg 应该在 PyPI 上可用，您可以通过以下步骤发布新版本

1. 在 setup.py 文件中更新版本号。有关版本号的选择方法，请参阅 PEP 440。

2. 确保您有必要的最新版本包

   pip install --upgrade setuptools wheel twine

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

   python setup.py sdist bdist_wheel && twine check dist/*
   

   修复您遇到的任何错误。

4. 将源分发上传到 PyPI

   twine upload dist/*
   

5. 提交任何未完成的更改

   git commit -a
   git push
   

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

   git tag 0.0.1
   git push --tags
   

许可证

AGPL