RIOS文件的分析和验证库
rios.core的Python项目详细描述
rios.core概述
core是一个Python包,提供基本验证和 符合RIOS的数据结构的格式化功能 规范(正式称为prismh)。
示例用法
这个包公开了一些用于验证和 格式化标准RIOS数据结构:
>>> from rios.core import validate_instrument, get_instrument_json >>> instrument = {"foo": "bar", "id": "urn:my-instrument", "title": "An Instrument Title", "record": [{"id": "field1","type": "text"}], "version": "1.0"} >>> validate_instrument(instrument) Traceback (most recent call last): ... colander.Invalid: {'': u'Unrecognized keys in mapping: "{\'foo\': \'bar\'}"'} >>> del instrument['foo'] >>> validate_instrument(instrument) >>> print get_instrument_json(instrument) { "id": "urn:my-instrument", "version": "1.0", "title": "An Instrument Title", "record": [ { "id": "field1", "type": "text" } ] }
有关可用功能的更多信息,请阅读api 文档。
贡献
我们非常欢迎对此包的贡献和/或修复。请提交 通过分叉此存储库并创建一个包含 变化。我们要求您包括单元测试和任何适当的 文档更新以及代码更改。
这个项目将遵循Semantic Versioning方法论,就像 可能,因此在生成依赖项目时,请使用适当的版本 限制。
通过执行 以下内容:
$ virtualenv rios $ cd rios $ . bin/activate $ hg clone ssh://hg@bitbucket.org/prometheus/rios.core $ cd rios.core $ pip install -e . $ pip install -r requirements.txt $ nosetests
许可证/版权
本项目是根据GNU Affero通用公共许可,版本 三。有关详细信息,请参见附带的LICENSE.rst文件。
版权所有(c)2015,普罗米修斯研究有限责任公司