CNXML图书馆连接
cnxml的Python项目详细描述
cnxml库
这是一个用于处理cnxml内容的python库,其中包括cnxml和collxml格式。
安装
此库要求python>;=3.5。
安装时使用:
pip install -e "."
测试
使用毒物进行检测:
tox
如果未安装TOX,请运行以下命令:
pip install tox
使用atom.io
编辑/验证文件准备工作
- 安装https://atom.io
- 获取cnxml rng架构文件
- 从https://github.com/Connexions/cnxml/releases下载最新版本(单击“zip”链接)
- 它应该在您的下载文件夹中
- 移动到~/.neb/
- 解压缩文件
- 它应该创建一个名为
cnxml-2.0.0
(其中包含/cnxml/xml/cnxml/schema/rng/0.7/cnxml-jing.rng
)的文件夹
- 将文件夹重命名为您不太可能意外删除的内容(例如
cnxml-validation
)- 在编辑
~/.atom/config.cson
时,请记住后面的名称。
- 从https://github.com/Connexions/cnxml/releases下载最新版本(单击“zip”链接)
- 它应该在您的下载文件夹中
- 移动到~/.neb/
- 解压缩文件
- 它应该创建一个名为
cnxml-2.0.0
(其中包含/cnxml/xml/cnxml/schema/rng/0.7/cnxml-jing.rng
)的文件夹 - 将文件夹重命名为您不太可能意外删除的内容(例如
cnxml-validation
)- 在编辑
~/.atom/config.cson
时,请记住后面的名称。
- 在编辑
安装
- 启动Atom
- 安装
linter-autocomplete-jing
包 - 键入<;kbd>;<;kbd>;+<;kbd>;,<;kbd>;(对于Mac)打开“设置”(或单击菜单栏中的atom,preferences…)
- 单击左侧的install。
- 输入
linter-autocomplete-jing
,然后单击install - alternative:从命令行运行
apm install linter-autocomplete-jing
- 通过单击菜单栏中的atom,config编辑
~/.atom/config.cson
,并添加以下行(在本文档底部) - 重新启动Atom
- 打开一个完整的拉链。(我从终端运行
atom ~/Downloads/col1234_complete
) - 通过打开一个
index.cnxml
文件并在文件中的某个位置键入<figure>
进行验证。如果它是一个有效的位置,那么它应该为您自动添加id=""
更改为~/.atom/config.cson
:
"*": core: customFileTypes: # Add this to the bottom of the customFileTypes area. # Note: Indentation is important! "text.xml": [ "index.cnxml" ] # And then this to the bottom of the file # 1. Make sure "linter-autocomplete-jing" only occurs once in this file! # 1. make sure it is indented by 2 spaces just like it is in this example. "linter-autocomplete-jing": displaySchemaWarnings: true rules: [ { priority: 1 test: pathRegex: ".cnxml$" outcome: schemaProps: [ { lang: "rng" path: "~/.neb/cnxml-validation/cnxml/xml/cnxml/schema/rng/0.7/cnxml-jing.rng" } ] } ]
许可证
本软件受GNU Affero通用条款的约束 公共许可3.0版(AGPL)。有关详细信息,请参见license.txt。 版权所有(c)2016莱斯大学
更改日志
3.0.1
- 重新发布3.0.0
3.0.0
- 为cnxml添加测试<;md:派生自…>;验证
- 修复从cnxml验证测试派生的失败
- 使用自关闭md:derived from作为有效代表
- 将元数据分析从 Press到cnxml(20)
- 添加一个cli实用程序,用于将cnxml元数据提取到json(22)
2.2.0
- 扩展验证API以接受多个要验证的文档
2.1.1
- 调整mdml模式以正确地允许派生自下的任何元数据元素
2.1.0
- 删除外部路径库依赖项
- 放弃对python<;=2.7的支持
- 使用versioneer进行项目版本控制
- setup.py中的正确许可证
- 添加使用atom.io编辑器进行验证的说明
2.0.0
- 为collXML验证添加命令行接口
- 重命名main cli函数为另一个入口点腾出空间
- 使collXML中需要元数据部分
- 添加collXML验证函数
1.1.0
- 对验证错误行数据使用namedtuple。
1.0.0
- 初次发布。