rios.core 0.9.0

示例用法

该包公开了一些简单的函数，用于验证和格式化标准 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 文档。

贡献

欢迎对此包的贡献和/或修复。请通过fork此存储库并创建包含您的更改的 Pull Request 来提交它们。我们要求您在代码更改的同时包括单元测试和适当的文档更新。

尽可能遵循 语义版本 方法，因此构建依赖项目时，请使用适当的版本限制。

可以通过以下步骤设置开发环境来工作于此包

$ python -m venv rios
$ cd rios
$ . bin/activate
$ git clone git@github.com:prometheusresearch/rios.core.git
$ cd rios.core
$ pip install -e .
$ pip install -r requirements.txt
$ pytest

许可/版权

本项目采用 Apache v2 许可证。有关详细信息，请参阅附带的 LICENSE.rst 文件。

版权所有 (c) 2015，Prometheus Research，LLC