PyHGNC 0.2.4

安装

PyHGNC 可以使用pip安装。

pip install pyhgnc

如果您因为无权安装而失败，请使用超级用户（推荐在 Linux 上使用 sudo）或……

pip install --user pyhgnc

如果您想确保在 python3 下安装它，请使用...

python3 -m pip install pyhgnc

SQLite

如果您不知道这意味着什么，请跳过MySQL/MariaDB setup部分。

不用担心！您可以随时更改配置。有关稍后更改数据库系统的更多信息，请转到 readthedocs 文档中的更改数据库配置 更改数据库配置的副标题。

MySQL/MariaDB 设置

以 root 用户身份登录 MySQL 并创建一个新数据库，创建一个用户，分配权限和刷新权限。

CREATE DATABASE pyhgnc CHARACTER SET utf8 COLLATE utf8_general_ci;
GRANT ALL PRIVILEGES ON pyhgnc.* TO 'pyhgnc_user'@'%' IDENTIFIED BY 'pyhgnc_passwd';
FLUSH PRIVILEGES;

有两个选项可以设置 MySQL/MariaDB。

1. 最简单的就是启动命令行工具

pyhgnc mysql

您将获得输入提示的指导。使用 RETURN 接受方括号中的默认值。你会看到这样的东西

server name/ IP address database is hosted [localhost]:
MySQL/MariaDB user [pyhgnc_user]:
MySQL/MariaDB password [pyhgnc_passwd]:
database name [pyhgnc]:
character set [utf8]:

将测试连接，如果成功则返回Connection was successful。否则你会看到以下提示

Test was NOT successful

Please use one of the following connection schemas
MySQL/MariaDB (strongly recommended):
        mysql+pymysql://user:passwd@localhost/database?charset=utf8

PostgreSQL:
        postgresql://user:passwd@localhost/database

MsSQL (pyodbc needed):
        mssql+pyodbc://user:passwd@database

SQLite (always works):

- Linux:
        sqlite:////absolute/path/to/database.db

- Windows:
        sqlite:///C:\absolute\path\to\database.db

Oracle:
        oracle://user:passwd@localhost:1521/database

2.第二个选项是启动一个python shell并设置MySQL配置。如果您没有更改上述 SQL 语句中的任何内容……

import pyhgnc
pyhgnc.set_mysql_connection()

如果您使用了自己的设置，请根据您的要求调整以下命令。

import pyhgnc
pyhgnc.set_mysql_connection(host='localhost', user='pyhgnc_user', passwd='pyhgnc_passwd', db='pyhgnc')

更新

更新过程将下载完整的 HGNC json 文件和 HCOP 文件。

import pyhgnc
pyhgnc.manager.database.update()

这将使用 PyHGNC 的默认连接设置或用户定义的设置。也可以从 shell 运行更新过程。

pyhgnc update

查询功能快速入门

初始化查询对象

query = pyhgnc.query()

获取所有 HGNC 条目：

all_entries = query.hgnc()