fair-identifiers-client

FAIR研究标识符服务客户端的SDK和CLI接口。

摘要

fair-identifiers-client包提供了对FAIR研究标识符服务的命令行和SDK接口。

先决条件

构建和安装fair-identifiers-client需要使用pipenv工具。使用命令pip install --user --upgrade pipenv或适合您的安装的类似命令先安装它。

构建

构建客户端的默认方法是使用make install，这将创建本地的可执行文件fair-identifiers-client。默认方法假设使用Python 3.6进行构建。可以通过在运行make install之前设置PYTHON_VERSION环境变量来强制使用其他版本的Python。例如，命令PYTHON_VERSION=2.7 make install将用于Python解释器的2.7版本构建。

目前，仅测试了Python 2.7和3.6版本。

运行

完成构建将在项目的基本目录中创建一个可执行文件 fair-identifiers-client。要运行命令的帮助信息，可以使用命令 fair-identifiers-client --help 查找。通常，第一个要执行的命令将是 fair-identifiers-client login，以创建在命令后续调用中与服务交互所需的凭据缓存。该 login 命令将打开一个网页浏览器，指导您使用 Globus 身份登录并提供同意，以便命令行工具代表您在 FAIR 研究标识符服务上执行操作。

用作 SDK

SDK 功能封装在源文件 fair_identifiers_client/identifiers_api.py 中。关于 IdentifierClient 类的各种方法的 Doc String 注释描述了操作的参数。

示例

from fair_identifiers_client.identifiers_api import identifiers_client
from fair_identifiers_client.config import config
# Loads tokens stored from config
client = identifiers_client(config)
client.create_identifier(namespace='<my_namespace>', visible_to=['public'])

用作命令行客户端

命令行客户端应用程序随安装提供，可以使用 fair-identifiers-client 使用。

示例

以下是一些示例命令

打印创建标识符的所有选项的信息

$ fair-identifiers-client identifier-create --help

创建一个标识符

fair-identifiers-client identifier-create --namespace <my_namespace> --visible-to public

更新标识符

添加位置

fair-identifiers-client identifier-update --identifier <myidentifier> --locations https://foo.example.com

添加多个字段

fair-identifiers-client identifier-update --identifier <myidentifier> --locations https://foo.example.com https://example.com/foo --checksum-sha256 sha256checksum --checksum-md5 mymd5checksum --metadata file://foo.json<!-- @IGNORE PREVIOUS: link -->