公平研究标识符服务客户端
fair-identifiers-client的Python项目详细描述
公平标识符客户端
FAIR Research Identifiers服务的客户端SDK和CLI。在
摘要
fair identifiers客户端包为fair Research identifiers服务提供命令行和SDK接口。在
先决条件
构建和安装公平标识符客户端需要使用^{pip install --user --upgrade pipenv或适合您的安装的类似命令预安装它。在
建筑
构建客户机的默认方法是使用make install，它创建本地可执行文件fair-identifiers-client。此默认方法假定使用Python3.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命令将打开一个web浏览器，该浏览器将引导您使用Globus身份登录，并允许命令行工具代表您在FAIR Research Identifiers服务上执行操作。在
用作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'])
用作命令行客户端
CLI客户端应用程序随安装而来，可与fair-identifiers-client一起使用
示例
下面是命令示例
打印用于创建标识符的所有选项的信息
^{pr2}$创建标识符
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 -->
- 项目
标签：
欢迎加入QQ群-->： 979659372
