DrugBank Downloader

无需担心DrugBank的许可和分发规则 - 只需使用drugbank_downloader编写代码，自动下载和使用它。

安装

$ pip install drugbank-downloader

下载特定版本

import os
from drugbank_downloader import download_drugbank

username = ...  # suggestion: load from environment with os.getenv('DRUGBANK_USERNAME')
password = ...

path = download_drugbank(version='5.1.7', username=username, password=password)

# This is where it gets downloaded: ~/.data/drugbank/5.1.7/full database.xml.zip
expected_path = os.path.join(os.path.expanduser('~'), '.data', 'drugbank', '5.1.7', 'full database.xml.zip')
assert expected_path == path.as_posix()

一旦下载一次，它就会变得智能，不需要再次下载。它将自动存储在~/.data/drugbank目录中，使用pystow。

自动配置DrugBank凭证

有两种方法可以自动设置用户名和密码，这样你就不必在Python代码中担心获取和传递它。

1. 在环境中设置DRUGBANK_USERNAME和DRUGBANK_PASSWORD
2. 创建~/.config/drugbank.ini并在[drugbank]部分设置username和password键。

from drugbank_downloader import download_drugbank

# Same path as before
path = download_drugbank(version='5.1.7')

此包中所有函数均支持username和password关键字参数，但在教程中为了简洁，将省略这些参数。

下载最新版本

首先，您需要使用pip install bioversions安装bioversions（链接：https://github.com/cthoyt/bioversions），该工具用于查询多个数据库的最新版本。然后，您可以修改之前的代码，省略version关键字参数。

import os
from drugbank_downloader import download_drugbank

path = download_drugbank()

# This is where it gets downloaded: ~/.data/drugbank/5.1.7/full database.xml.zip based on the latest
# version, as of December 14th, 2020.
expected_path = os.path.join(os.path.expanduser('~'), '.data', 'drugbank', '5.1.7', 'full database.xml.zip')
assert expected_path == path.as_posix()

version关键字参数在此包的所有函数中均可用，但为了简洁，将与username和password一样省略。

无需解包 - 直接读取full database.xml.zip

DrugBank是一个位于zip存档内的单个XML（未来可能为JSON）文件。通常，人们会手动解压这个文件夹，然后对生成的文件进行操作。请不要这样做，因为它不可重复！相反，可以使用以下代码在Python中将它作为文件对象打开。

import zipfile
from drugbank_downloader import download_drugbank

path = download_drugbank()

with zipfile.ZipFile(path) as zip_file:
    with zip_file.open('full database.xml') as file:
        pass  # do something with the file

您没有时间记住这些。只需使用drugbank_downloader.open_drugbank()即可。

from drugbank_downloader import open_drugbank

with open_drugbank() as file:
    pass  # do something with the file, same as above

读取DrugBank的XML

打开文件后，您可能想使用XML解析器（如）读取它。

from xml.etree import ElementTree
from drugbank_downloader import open_drugbank

with open_drugbank() as file:
    tree = ElementTree.parse(file)

您也没有时间记住这些。只需使用drugbank_downloader.parse_drugbank()即可。

from xml.etree import ElementTree
from drugbank_downloader import parse_drugbank

tree = parse_drugbank()
root = tree.getroot()

如果您对树的第一件事就是获取其根，只需使用drugbank_downloader.get_drugbank_root()即可。

from drugbank_downloader import get_drugbank_root

root = get_drugbank_root()

您现在已经知道了我可以教给您的一切。请使用这些工具进行可重用、可重复的科学！

存储在另一个位置

如果您想使用pystow（例如，在pyobo中我也保留了一个副本）将数据存储在其他位置，可以使用prefix参数。

import os
from drugbank_downloader import download_drugbank

path = download_drugbank(prefix=['pyobo', 'raw', 'drugbank'])

# This is where it gets downloaded: ~/.data/pyobo/raw/drugbank/5.1.7/full database.xml.zip
expected_path = os.path.join(os.path.expanduser('~'), '.data', 'pyobo', 'raw', 'drugbank', '5.1.7',
                             'full database.xml.zip')
assert expected_path == path.as_posix()

有关进一步配置存储位置的更多信息，请参阅pystow的文档。

通过CLI下载

安装后，运行以下CLI命令以确保它并将路径发送到标准输出

$ drugbank_downloader

如果您尚未预配置用户名和密码，可以使用--username和--password选项指定它们。

👐 贡献

我们欢迎任何形式的贡献，无论是提交问题、创建拉取请求还是进行分支操作。有关如何参与的信息，请参阅CONTRIBUTING.md。

👋 赋权

⚖️ 许可证

此包中的代码受MIT许可证许可。

🍪 Cookiecutter

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

🛠️ 开发者

git clone git+https://github.com/cthoyt/drugbank-downloader.git
cd drugbank-downloader
pip install -e .

pip install cruft
cruft update

tox -e py

git clone git+https://github.com/cthoyt/drugbank-downloader.git
cd drugbank-downloader
tox -e docs
open docs/build/html/index.html

[distutils]
index-servers =
    pypi
    testpypi

[pypi]
username = __token__
password = <the API token you just got>

# This block is optional in case you want to be able to make test releases to the Test PyPI server
[testpypi]
repository = https://test.pypi.org/legacy/
username = __token__
password = <an API token from test PyPI>

tox -e finish