跳转到主要内容

FAIR Data Point的Python实现

项目描述

FAIR Data Point (FDP)

PyPI Docker Image Version (latest by date) DOI Research Software Directory Build Status Coverage Status

FAIR Data Point的Python实现。

FDP是一个RESTful Web服务,使数据所有者能够描述和公开他们的数据集(元数据),以及使数据使用者能够根据FAIR数据指导原则发现更多关于可用数据集的信息。特别是,FDP通过在四个层次上提供机器可读的描述(元数据)来处理数据的可发现性或可查找性。

FDP->目录->数据集->分布

FDP软件规范可以在这里找到

FDP已在以下语言中实现

安装

要安装FDP,请执行以下操作

从PyPI

pip install fairdatapoint

或从此存储库

git clone https://github.com/NLeSC/fairdatapoint.git
cd fairdatapoint
pip install .

运行

fdp-run localhost 80

FDP服务启用了Swagger UI,您可以通过访问http://localhost进行尝试。

单元测试

使用以下命令运行测试(包括覆盖率)

pip install .[tests]
pytest

待办事项:在此处包括您项目的完整文档链接。

使用Docker部署

检查 fairdatapoint-service

不使用Docker部署

在部署FDP之前,首先需要有一个运行中的SPARQL数据库,该数据库可以用于存储元数据。

pip install fairdatapoint

# fdp-run <host> <port> --db=<sparql-endpoint>
# Let's assume your <host> is 'example.com' and <sparql-endpoint> is 'http://example.com/sparql', then
fdp-run example.com 80 --db='http://example.com/sparql'

Web API文档

FAIR数据点(FDP)公开以下端点(URL路径)

端点 GET POST PUT DELETE
fdp 输出fdp元数据 创建新的fdp元数据 更新fdp元数据 不允许
catalog 输出所有目录ID 创建新的目录元数据 不允许 不允许
dataset 输出所有数据集ID 创建新的数据集元数据 不允许 不允许
distribution 输出所有分发ID 创建新的分发元数据 不允许 不允许
catalog/ 输出元数据 不允许 更新元数据 删除元数据
dataset/ 输出元数据 不允许 更新元数据 删除元数据
distribution/ 输出元数据 不允许 更新元数据 删除元数据

通过端点访问以程序方式请求元数据

FDP: curl -iH 'Accept: text/turtle' [BASE URL]/fdp

目录: curl -iH 'Accept: text/turtle' [BASE URL]/catalog/catalog01

数据集: curl -iH 'Accept: text/turtle' [BASE URL]/dataset/dataset01

分发: curl -iH 'Accept: text/turtle' [BASE URL]/distribution/dist01

FDP支持以下RDF序列化(MIME类型)

  • Turtle: text/turtle
  • N-Triples: application/n-triples
  • N3: text/n3
  • RDF/XML: application/rdf+xml
  • JSON-LD: application/ld+json

贡献

如果您想为FAIR数据点的开发做出贡献,请查看贡献指南

许可证

版权(c)2019,

根据Apache许可证第2版(“许可证”)授权;除非遵守许可证规定,否则不得使用此文件。您可以在以下位置获得许可证副本:

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意,否则在许可证下分发的软件按“原样”基础分发,不提供任何明示或暗示的保证。有关许可证中规定的权限和限制的具体语言,请参阅许可证。

致谢

此软件包是用CookiecutterNLeSC/python-template创建的。

项目详情


下载文件

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

源分发

fairdatapoint-0.7.2.tar.gz (23.6 kB 查看哈希值)

上传时间

构建分发

fairdatapoint-0.7.2-py3-none-any.whl (19.4 kB 查看哈希值)

上传时间 Python 3

由以下支持