README.zh-CN.md

English | 简体中文

Flask-State

Flask-State是一款在您浏览器上使用的轻便、图表化插件。

• 监控状态：CPU，内存，磁盘，磁盘IO, 网络IO, LoadAvg，启动时长。
• 可扩展：除记录本机状态外，还包括丰富的扩展功能选择。其中有Redis监控、用户验证、自定义logging和i18n等。
• 稳定：轻量级的依赖关系，同时解决了多进程并发问题。

Flask-State是一个活跃的项目，经过了充分的测试以及有一系列的更新计划。

Documentation

在这里 live demo 可以了解到使用样例, 或者你可以移动到 tutorial 获取更多信息.

Installation

从这里 PyPI 下载:

pip install Flask-State

通过NPM安装Flask-State或将此脚本标签放在HTML文件的开头部分:

<script src="https://cdn.jsdelivr.net/gh/yoobool/[email protected]/packages/umd/flask-state.min.js"></script>
<link href="https://cdn.jsdelivr.net/gh/yoobool/[email protected]/packages/flask-state.min.css" rel="stylesheet">

npm install flask-state --save

Usage

Flask-State插件安装后，还需要引入JavaScript文件和CSS文件，然后初始化组件运行方式。在某些配置上，你也可以选择修改。

1. 绑定数据库地址

from flask_state import DEFAULT_BIND_SQLITE
app.config['SQLALCHEMY_BINDS'] = {DEFAULT_BIND_SQLITE: 'sqlite:///path'}

2. 配置 Flask-State

import flask_state
flask_state.init_app(app)

3. 引入相关模块用于展示

// requires echarts module
import 'echarts';
import 'flask-state/flask-state.min.css';
import {init} from 'flask-state';
// Create a DOM node with ID 'test'. After init() binds the node,
// click to open the listening window
init({dom:document.getElementById('test')});

了解更多可配置选项 教程.

Contributing

RoadMap 中有我们下一步的开发计划.

• 需要其它帮助?
• 提出新的问题.
• 查看其他PR.

Flask-State遵循《贡献者公约》 行为准则。

Alternatives

其他类似的监控开源项目:

• Flask-MonitoringDashboard

Contributing

我们非常欢迎提出问题!

Community Channel

我们在 Gitter 等你! 请加入我们。

License

Flask State使用BSD-3-Clause许可证。