FAIRsharing客户端

FAIRsharing API的客户端。

💪 开始使用

FAIRsharing是一个关于标准、数据库和政策高质量元数据的注册处。然而，FAIRsharing数据的两个方面使其难以使用

1. 它受限制的CC-BY-SA 4.0许可证约束（见https://fairsharing.org/licence）。这使得即使部分数据也很难进行重新分发。社区重新使用的更好选项是CC-BY 4.0或理想情况下CC0。但是，请记住，FAIR和Open绝对是不同的。
2. 它不是提供批量下载，而是提供一个需要使用JWT进行身份验证的API。

尽管JWT没有问题，但它需要几个步骤，这对于经验较少的程序员来说在程序访问上并不方便。 fairsharing_client 包提供了一种方法，可以自动从API批量下载所有内容，并以可重复的方式本地存储，这样你就可以编写依赖于FAIRsharing数据的代码，而不必担心如何与其API交互或自行分发其数据。此外，此包对内容进行了一些预处理，使其更有用。

import fairsharing_client as fc

# Download the data and return the path of the YAML file
# This takes about 4 minutes and gets around 4K records.
path = fc.ensure_fairsharing()

# Download the data and open it for use
data = fc.load_fairsharing() 

# Get data for a given record
chebi_record = data["FAIRsharing.62qk8w"]

进行身份验证的方法有几种

1. 环境变量：设置 FAIRSHARING_LOGIN 和 FAIRSHARING_PASSWORD 环境变量
2. 配置：在 ~/.config/fairshairing.ini 文件中，添加以下配置

   [fairsharing]
   login = cthoyt@gmail.com
   password = ...
   

3. 关键字参数：将 login 和 password 关键字传递给示例函数中的任何一个。

提醒：此存储库不会重新分发FAIRsharing的数据，它只提供供您自行获取的代码。

🚀 安装

可以从 PyPI 安装最新的版本

$ pip install fairsharing_client

可以直接从GitHub使用以下方法安装最新代码和数据

$ pip install git+https://github.com/cthoyt/fairsharing-client.git

👐 贡献

欢迎贡献，无论是提交问题、提出拉取请求还是分叉，都表示感谢。有关如何参与的更多信息，请参阅 CONTRIBUTING.md。

👋 属性

⚖️ 许可证

此包中的代码根据MIT许可证授权。

🍪 Cookiecutter

此包是用@audreyfeldroy的cookiecutter包以及@cthoyt的cookiecutter-snekpack模板创建的。

🛠️ 开发者

$ git clone git+https://github.com/cthoyt/fairsharing-client.git
$ cd fairsharing-client
$ pip install -e .

$ tox

$ git clone git+https://github.com/cthoyt/fairsharing-client.git
$ cd fairsharing-client
$ tox -e docs
$ open docs/build/html/index.html

$ tox -e finish