技术期刊的大梁插件
girder-tech-journal的Python项目详细描述
设置说明
安装必备程序
遵循大梁 系统先决条件文档,以确保 对于PIP安装的大梁版本,有必要的程序可用。
注意: 技术日志插件需要node.js 8+。当遵循 文档要启用node.js apt存储库,请使用:
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
注意: 技术日志插件要求MongoDB至少为3.4+。当遵循 安装MongoDB的文档,将"3.2"替换为"3.4"
echo"deb http://repo.mongodb.org/apt/debian jessie/mongodb-org/3.4 main"\ | sudo tee /etc/apt/sources.list.d/mongodb-org-3.4.list
或
echo"deb http://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/3.4 multiverse"\ | sudo tee /etc/apt/sources.list.d/mongodb-org-3.4.list
设置技术日志插件
插件可以直接从pip安装:
pip install girder-tech-journal
或者通过克隆此存储库
git clone https://github.com/girder/tech_journal
cd tech_journal
pip install .
在git repo目录中,按照安装文档创建 虚拟环境和从pypi安装大梁。不安装Web客户端 图书馆还没有。以下说明假定您已输入虚拟 环境。
安装纱线
npm install -g yarn
安装Web软件包:
cd girder-tech-journal-gui
yarn install
要运行开发服务器:
yarn run serve
要为生产构建独立的Web应用程序:
OTJ (collection) ├── 2016 Jan-Jun (folder) │ ├── Submission 1 (folder) │ │ └── Revision 1 | | └── blah.tar │ │ └── Revision 2 | | └── blah_v2.tar │ └── Submission 2 (folder) │ │ └── Revision 1 │ └── Paper.docx └── 2016 Jun-Dec (folder) └── Submission 3 (folder) └── Revision 1 └── Paper2.docx0
如果您已经克隆了repo并正在为插件开发,那么在 setup.py 中有一个自定义命令 自动安装纱线包,为生产构建前端,并将dist文件夹复制到正确的位置。 要使用它,请运行: python setup.py build\u ui
警告
如果您在开发模式下运行 大梁服务 ,则独立前端将不会在 /tech_journal 服务。 这是因为预计前端将按顺序单独服务(例如 纱线输送服务 以查看正在进行的更改。如果出于某种原因,您需要在 /tech_journal 为前端服务,您将需要 在生产模式下运行 大梁服务 。但是请注意,在这种情况下,它提供的是预构建文件, 因此,在重建前端之前,任何更改都不会生效(例如,通过运行 python setup.py build_ui )。
安装大梁工人
提交上传页面能够提交github url和 让技术日志下载存储库的 master 分支 作为提交文件的下载提供。要做到这一点, 它使用 gimer\u worker 工具。当 安装技术日志插件。
安装rabbitmq
按照 rabbitmq 文档进行安装。
安装后,请确保服务正在运行
OTJ (collection) ├── 2016 Jan-Jun (folder) │ ├── Submission 1 (folder) │ │ └── Revision 1 | | └── blah.tar │ │ └── Revision 2 | | └── blah_v2.tar │ └── Submission 2 (folder) │ │ └── Revision 1 │ └── Paper.docx └── 2016 Jun-Dec (folder) └── Submission 3 (folder) └── Revision 1 └── Paper2.docx1
安装技术日志任务
在 技术日志任务目录中找到的包也需要 在开始梁工之前安装到环境中 程序:
我是acc输入 技术日志任务 目录完成 并使用 install 指令执行setup.py文件。
OTJ (collection) ├── 2016 Jan-Jun (folder) │ ├── Submission 1 (folder) │ │ └── Revision 1 | | └── blah.tar │ │ └── Revision 2 | | └── blah_v2.tar │ └── Submission 2 (folder) │ │ └── Revision 1 │ └── Paper.docx └── 2016 Jun-Dec (folder) └── Submission 3 (folder) └── Revision 1 └── Paper2.docx2
启动大梁工人
执行 大梁工作程序将启动任务侦听器。如果 其中一个已经接受rabbitmq的默认安装,没有 对大梁工人配置进行必要的更改以允许其连接 拉比马克。使用以下命令启动大梁工人:
OTJ (collection) ├── 2016 Jan-Jun (folder) │ ├── Submission 1 (folder) │ │ └── Revision 1 | | └── blah.tar │ │ └── Revision 2 | | └── blah_v2.tar │ └── Submission 2 (folder) │ │ └── Revision 1 │ └── Paper.docx └── 2016 Jun-Dec (folder) └── Submission 3 (folder) └── Revision 1 └── Paper2.docx3
查看第一组输出时,请确保 processgithub 和 SurveySubmission 任务列在 [任务]标题下:
OTJ (collection) ├── 2016 Jan-Jun (folder) │ ├── Submission 1 (folder) │ │ └── Revision 1 | | └── blah.tar │ │ └── Revision 2 | | └── blah_v2.tar │ └── Submission 2 (folder) │ │ └── Revision 1 │ └── Paper.docx └── 2016 Jun-Dec (folder) └── Submission 3 (folder) └── Revision 1 └── Paper2.docx4
配置插件
打开新终端并激活虚拟环境。
OTJ (collection) ├── 2016 Jan-Jun (folder) │ ├── Submission 1 (folder) │ │ └── Revision 1 | | └── blah.tar │ │ └── Revision 2 | | └── blah_v2.tar │ └── Submission 2 (folder) │ │ └── Revision 1 │ └── Paper.docx └── 2016 Jun-Dec (folder) └── Submission 3 (folder) └── Revision 1 └── Paper2.docx5
构建大梁web客户端并启动服务器:
OTJ (collection) ├── 2016 Jan-Jun (folder) │ ├── Submission 1 (folder) │ │ └── Revision 1 | | └── blah.tar │ │ └── Revision 2 | | └── blah_v2.tar │ └── Submission 2 (folder) │ │ └── Revision 1 │ └── Paper.docx └── 2016 Jun-Dec (folder) └── Submission 3 (folder) └── Revision 1 └── Paper2.docx6
注意: 尽管通常大梁希望重建新激活的 插件,现在不需要这样做了,因为我们正在 "独立"模式,不受大梁建造系统控制
创建管理员用户
在Web浏览器中打开http://localhost:8080/" rel="nofollow">http://localhost:8080/,您将看到 大梁欢迎页。
系统中创建的第一个用户将自动被授予管理员 对实例的权限,因此在启动后首先应该执行的操作 您的第一次实例是注册用户。成功之后, 您应该会在导航栏中看到一个链接,上面写着"管理控制台"。
生成文件夹结构
首先,生成一个"集合"来表示otj的总信息。 这可以通过点击左边菜单中的 集合和 然后单击"创建集合"按钮。输入名称和 说明,然后单击"创建"。
也可以通过使用 插件/admin/journal OTJ页。
注意 集合的说明必须包含字符串 日志由某些OTJ页面获取。
此文件夹的"唯一ID",可通过单击蓝色 带有 i 的按钮,稍后将用于配置技术日志 插件,
然后,在该集合中生成一个文件夹作为第一个将 提交给。这是通过单击 收集操作来完成的 菜单并选择此处的"创建文件夹"。"收集操作"按钮 从上面蓝色按钮的右边可以找到。输入名称并 第一个文件夹的说明,然后再次单击"创建"。
启用技术日志插件
要启用该插件,请转到 管理控制台并单击 插件 链接。
将显示当前插件的列表,向下滚动至 Technical Journal Plugin 并通过关闭 滑块启用它 转到打开位置。
单击"配置插件"图标,它看起来像一个小齿轮。
这将显示用于配置midas实例的5个字段 技术期刊。只有默认日记账项才需要 在这一点上填写。输入 在上面生成并单击保存配置
保存后,应该配置插件并准备好使用。 访问插件的入口点:
OTJ (collection) ├── 2016 Jan-Jun (folder) │ ├── Submission 1 (folder) │ │ └── Revision 1 | | └── blah.tar │ │ └── Revision 2 | | └── blah_v2.tar │ └── Submission 2 (folder) │ │ └── Revision 1 │ └── Paper.docx └── 2016 Jun-Dec (folder) └── Submission 3 (folder) └── Revision 1 └── Paper2.docx7
或者类似于本地主机实例:
OTJ (collection) ├── 2016 Jan-Jun (folder) │ ├── Submission 1 (folder) │ │ └── Revision 1 | | └── blah.tar │ │ └── Revision 2 | | └── blah_v2.tar │ └── Submission 2 (folder) │ │ └── Revision 1 │ └── Paper.docx └── 2016 Jun-Dec (folder) └── Submission 3 (folder) └── Revision 1 └── Paper2.docx8
警告
菜单栏中的一些链接 日志 和 帮助 ,不指向 插件y中的有效位置et.新提交的 和 主页 链接将带您进入正确的页面。
释放
更新pypi版本:
第一个增量版本是setup.py。然后运行:
OTJ (collection) ├── 2016 Jan-Jun (folder) │ ├── Submission 1 (folder) │ │ └── Revision 1 | | └── blah.tar │ │ └── Revision 2 | | └── blah_v2.tar │ └── Submission 2 (folder) │ │ └── Revision 1 │ └── Paper.docx └── 2016 Jun-Dec (folder) └── Submission 3 (folder) └── Revision 1 └── Paper2.docx9