注释器的数据库后端(http://annotatorjs.org)
annotator的Python项目详细描述
注释器存储
这是注释器的后端存储区。
功能大致可以分为两部分:
- 封装ElasticSearch的抽象层,便于管理注释 存储。它具有根据 他们的权限设置。
- 向注释公开http api的web服务器的flask蓝图 存储。要使用此功能,请使用 [烧瓶] 构建此包 选项. < > >
开始
您需要一个最新版本的python(python 2>;=2.6 或者python 3>;=3.3)和 elasticsearch (>;=1.0.0) 已安装。
最快的方法需要 pip 和 virtualenv 工具( 轻松安装virtualenv 将两者兼得)。运行 在存储库根目录中执行以下操作:
virtualenv pyenv source pyenv/bin/activate pip install -e .[flask] cp annotator.cfg.example annotator.cfg python run.py
您应该看到如下内容:
* Running on http://127.0.0.1:5000/ * Restarting with reloader...
如果要自定义注释器存储的配置,请使 您对 annotator.cfg 或进入 run.py 的更改
此外, 主机 和 端口 环境变量覆盖 地址 127.0.0.1 和端口 5000 的默认套接字绑定
运行测试
我们使用nosetests来运行测试。你可以 pip install -e [测试] ,确保elasticsearch正在运行,并且 然后:
$ nosetests ...................................................................................... ---------------------------------------------------------------------- Ran 86 tests in 19.171s OK
或者(最好)安装 毒性 ,然后运行毒性。这将运行 针对多个python版本的测试(如果有 已安装)。
请 打开问题 如果您发现测试并没有在您的机器上全部通过,请确保包括 pip freeze的输出