wikidp/portal

Wikidata DP门户原型

镜像概述和主要用途

Wikidata DP门户原型是一个基于Flask框架开发的Python Web应用，旨在提供Wikidata数字保存门户的原型实现。目前主要用于本地开发和测试，尚未准备好作为可靠应用部署到生产服务器。

核心功能和特性

• 基于Flask框架的轻量级Web应用
• 与Wikidata交互，需通过用户凭据验证
• 支持本地开发环境快速搭建
• 包含测试框架和覆盖率报告功能
• 提供Ansible部署配置，支持Vagrant本地虚拟机环境

前置要求

• Git或最新源代码副本
• 操作系统：MacOS或Linux（暂不支持Windows）
• Python 3（不支持Python 2）
• Python pip（用于安装Python模块）

建议使用Python虚拟环境，可避免版本冲突并和谐运行Python 3和Python 2应用，详情参考虚拟环境入门。

使用方法和配置说明

快速开始

门户是用Python编写的Flask Web应用，在Python 3环境下易于安装。当前为本地开发安装版本，主要步骤包括：

1. 获取代码
2. 设置Python 3虚拟环境（可选但推荐）
3. 安装门户原型及其依赖
4. 运行门户

获取代码

克隆仓库并进入项目根目录：

bash
git clone https://github.com/WikiDP/portal-proto.git
cd portal-proto

或下载并解压源代码归档：

bash
wget https://github.com/WikiDP/portal-proto/archive/master.zip
unzip master.zip
rm master.zip
cd portal-proto-master

设置Python 3虚拟环境（可选）

在项目根目录的venv子目录中创建虚拟环境并激活：

bash
virtualenv -p python3 venv
source ./venv/bin/activate

也可运行根目录中的辅助脚本：$ ./venv.sh。成功后终端提示符会显示(venv)标记。

虚拟环境只需创建一次，可通过删除venv子目录移除。每次启动新终端会话时需重新激活：source ./venv/bin/activate。

安装应用和依赖

使用pip安装应用：

bash
(venv) $ source ./venv/bin/activate
(venv) $ pip install -e .

-e参数使pip监控目录并重新编译更改，适合开发环境，稳定部署时应省略。

也可使用辅助脚本：(venv) $ ./setup.sh。

运行应用

每次新终端会话需执行以下步骤：

1. 设置Wikidata用户名和密码凭据，以及Flask应用名称环境变量：

bash
(venv) $ export WIKIDP_BOT_USER='<用户名>'
(venv) $ export WIKIDP_BOT_PASSWORD='<密码>'
(venv) $ export FLASK_APP='wikidp'

其中<用户名>和<密码>为您的Wikidata账号信息。注意：这些变量需在每个新会话中重新设置。

2. 运行Flask应用：

bash
(venv) $ flask run

或使用项目根目录中的run.sh脚本，需先编辑脚本替换凭据占位符：

bash
export WIKIDP_BOT_USER='<用户名>'
export WIKIDP_BOT_PASSWORD='<密码>'

在浏览器中访问<[***]>即可查看门户原型。

应用测试

所有测试位于tests目录，使用py.test管理测试接口。

运行测试

bash
(venv) $ pytest

检查测试覆盖率

提供bash脚本处理覆盖率报告：

bash
(venv) $ ./coverage_report.sh

如需可视化Web界面报告，可生成htmlcov/index.html文件：

bash
(venv) $ ./coverage_report.sh visual

Ansible部署

本地Vagrant虚拟机

bash
vagrant up

本地安装Ansible角色

bash
ansible-galaxy install -r ansible/requirements.yml

Ansible CLI部署到本地Vagrant VM

bash
ansible-playbook --key-file=.vagrant/machines/default/virtualbox/private_key -v --inventory ansible/vagrant vagrant.yml

通过SSH首次设置服务器（需服务器root密码）

bash
ansible-playbook ansible/setup.yml -i ansible/staging.yml -u root -vv -k

Python 3.6安装参考：

bash
wget https://www.python.org/ftp/python/3.6.3/Python-3.6.3.tgz
tar xvf Python-3.6.3.tgz
cd Python-3.6.3
./configure --enable-optimizations
make -j8
sudo make altinstall
python3.6

故障排除

设置FLASK_APP环境变量

若出现以下错误：

shell
Usage: flask run [OPTIONS]

Error: Could not locate Flask application. You did not provide the FLASK_APP environment variable.

For more information see http://flask.pocoo.org/docs/latest/quickstart/

需设置FLASK_APP环境变量，详见快速开始部分。

本代码以GPLv3许可证发布。