跳转到主要内容

开放元数据标记语言

项目描述

gh actions tests Build status Test coverage PyPI version Read the Docs

odML (Open metaData Markup Language) 核心库

开放元数据标记语言是一种基于文件格式(XML、JSON、YAML),用于以组织化的人机和机器可读方式存储元数据。odML 是一个定义和建立开放、灵活且易于使用的格式来传输元数据的倡议。

Python-odML库可以通过pip轻松安装。源代码在GitHub上免费提供。如果您不熟悉版本控制系统git,但仍想使用它,请查看git-scm网站上的文档。

odML项目页面

有关项目的更多信息,包括相关项目、教程和示例,可以在我们的odML 项目页面上找到。

入门指南

安装

python-odml最方便的安装方式是通过pip。

pip install odml

要安装odml的最新开发版本,可以使用pip的git安装选项

pip install git+https://github.com/G-Node/python-odml

请注意,这个版本可能不稳定。

教程和示例

  • 我们汇编了一套教程

Python便捷脚本

Python安装具有多个便捷的命令行脚本。

  • odmlconvert:将旧版本odML文件转换为当前版本。
  • odmltordf:将odML文件转换为odML支持的RDF版本。
  • odmlview:在网页浏览器中渲染和浏览本地的XML odML文件。

所有脚本都通过在命令中添加help标志提供详细的用法描述。

odmlconvert -h
odmltordf -h
odmlview -h

重大变更

与odML之前的版本相比,odML版本1.4引入了破坏性的格式和API变更。可以使用odml/tools包中的版本转换器将以前格式版本的文件转换为1.4兼容的格式。

请注意,值dtype binary已被删除。不建议将实际二进制数据合并到odML文件中,而是使用URL dtype提供对原始文件的引用。

有关引入的变更的详细信息,请查看GitHub发行说明

依赖项

  • Python 3.7+

  • Python包

    • lxml(版本3.7.2)
    • yaml(版本>= 5.1)
    • rdflib(版本>=4.2.2)
  • 如果使用pip方法安装odML,这些包将自动下载并安装。否则,可以从OS包管理器安装它们。在Ubuntu上,它们可用作

    • python-lxml
    • python-yaml
    • python-rdflib
  • 如果您希望在Ubuntu 14.04上使用Python包管理器安装,则需要以下包来构建lxml Python包

    • libxml2-dev
    • libxslt1-dev
    • lib32z1-dev

以前的Python版本

Python 2已达到生命周期的结束。当前的odml版本和未来的版本与Python 2不兼容。我们于2020年8月删除了Python 2的支持,版本为1.5.2。我们还建议使用Python版本>= 3.7。如果Python版本< 3.7是必需的,则还需要安装以下依赖项

  • pip安装
    • enum34(版本0.4.4)
  • apt安装
    • python-enum

从源码构建

要下载Python-odML库,请使用git并从GitHub克隆存储库

  $ git clone https://github.com/G-Node/python-odml.git

如果您不想使用git,可以下载GitHub上提供的ZIP文件到您的计算机上(例如,在上面的家目录下的“toolbox”文件夹中)。

要安装Python-odML库,请进入相应的目录并运行

  $ cd python-odml
  $ python setup.py install

注意 master分支是我们的当前开发分支,可能不是所有功能都按预期工作。请使用发布标签。

贡献和治理

有关更多信息,请参阅CONTRIBUTING文档。

错误和问题

如果您发现可能是bug的行为,请在此处提交bug报告:GitHub bug tracker

如果您对库的使用有任何疑问,请随时加入freenode上的#gnode IRC频道。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

odML-1.5.4.tar.gz (155.5 kB 查看哈希值)

上传时间

构建分发

odML-1.5.4-py3-none-any.whl (94.4 kB 查看哈希值)

上传时间 Python 3

支持单位: