跳转到主要内容

Beergarden前端

项目描述

Brew View是beer-garden应用程序的前端。它使用Tornado来处理一些REST端点,并通过Thrift与beer-garden后端(Bartender)通信。

Gitter PyPI Build Status Code Coverage Documentation Status Pyup Updates

入门指南

以下步骤是从源代码启动Brew-view的最简单方法。

先决条件

  • Python (2.7.9+ 或 3.4+)

  • 安装了全局yarn的Node.js(稳定版,6+)

  • 连接到MongoDB服务器

  • 连接到RabbitMQ服务器

启动并运行

RabbitMQ和Mongo的完整安装指南超出了本文档的范围。以下是一个小片段,如果您已安装docker,则可以帮助您启动。

$ docker run -d -p 27017:27017 --name bg-mongo mongo
$ docker run -d -p 5672:5672 -p 15672:15672 --name bg-rmq rabbitmq:3-management-alpine

要在本地进行开发,请注意,brew-view是由由tornado支持的Python API和AngularJS应用程序的组合。因此,我们将同时启动它们!

$ git clone https://github.com/beer-garden/brew-view.git
$ cd brew-view
$ make deps # just a simple way to do pip install -r requirements.txt and yarn install

启动JavaScript应用程序

$ cd brew_view/static
$ yarn serve

现在启动Python API

$ cd /path/to/brew-view
$ python -m brew_view -c ./dev_conf/config.yml

太棒了!现在一切应该都已启动并运行。在浏览器中访问http://localhost:8080/来检查。按Ctrl-c停止web服务器。

注意:值得注意的是,JavaScript应用程序在8080上运行,而Python应用程序在2337上运行。

配置

随安装包附带的 conf/config.yml 文件。它包含合理的默认值,但如果你愿意,可以随意更改它们。在做出任何更改后,您需要重新启动 Web 服务器。

REST 服务

Brew-view 的主要任务是提供前端应用程序,但它还提供 REST API。该 API 由前端(以及插件)用于与 beer-garden 的其他部分交互。如果您想直接使用 REST API,当然欢迎——您可以通过导航到“关于”页面并点击“查看!”按钮来找到 Swagger 文档。

测试和代码覆盖率

您可以自己运行测试。

Python

$ make test

这将运行 Python 应用程序的测试。您可以使用 tox 在多个 Python 版本上运行。

$ make test-all

生成覆盖率

$ make coverage

我们使用 flake8 进行代码检查

$ make lint

JavaScript

JavaScript 应用程序有自己的 Makefile,因此要运行这些命令,您需要处于 brew_view/static 目录中。

由于我们切换到了 webpack,我们目前缺少良好的 JavaScript 测试。我们希望在不远的将来解决这个问题。您应该能够运行测试

$ make test

运行 ESLint

make lint

分发

创建 brew-view 分发很简单。只需进入 git 根目录并运行以下命令

$ make dist

项目详情


下载文件

下载您平台的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源分发

brew-view-2.4.21.tar.gz (10.6 MB 查看哈希值

上传时间

构建分发

brew_view-2.4.21-py2.py3-none-any.whl (10.7 MB 查看哈希值

上传时间 Python 2 Python 3

由以下支持