快速搭建web见面

Rodja Trappe fd91f65a2e more plot documentation 4 years ago
.github fc127dc4fe trying to make automated pypi releases with poetry 4 years ago
.vscode 852faab6b1 do not set blank lines 4 years ago
nicegui fd91f65a2e more plot documentation 4 years ago
sceenshots fd91f65a2e more plot documentation 4 years ago
.gitignore 11844e40cc cleanup 4 years ago
Dockerfile e11050e6f3 made dev container debuggable 4 years ago
LICENSE 0cb68ea25c Adding license 4 years ago
README.md fd91f65a2e more plot documentation 4 years ago
docker-compose.yml 72d4c24e8b do not show reloading popups 4 years ago
docker.sh 627296fbd6 simplified docker.sh 4 years ago
main.py 1541486165 some design doc 4 years ago
nicegui.code-workspace e11050e6f3 made dev container debuggable 4 years ago
poetry.lock 125e7db7c5 fixing dependencies and cleaner Dockerfile 4 years ago
pyproject.toml fd28733c72 fixed syntax 4 years ago
setup.py 722462189c renaming from nice_gui to nicegui 4 years ago

README.md

NiceGUI

We like Streamlit but find it does to much magic when it comes to state handling. In search for an alernative nice library to write simple graphical user interfaces in Python we discovered justpy. While too "low-level-html" for our daily usage it provides a great basis for our shot at a "NiceGUI".

Features

  • browser-based GUI
  • implicit reload on code change
  • clean set of GUI elements (label, button, checkbox, switch, slider, input, ...)
  • simple grouping with rows, columns and cards
  • built-in timer to refresh data in intervals (even every 10 ms)
  • straight-forward data bindings to write even less code

Install

python3 -m pip install nicegui

Usage

Write your nice GUI in a file main.py:

from nicegui import ui

ui.label('Hello NiceGUI!')
ui.button('BUTTON', on_click=lambda: print('button was pressed'))

Launch it with:

python3 main.py

Note: The script will automatically reload the GUI if you modify your code.

API

See main.py for an extensive example what you can do with NiceGUI.

Design

We use the Quasar Framework and hence have their full design power. Each NiceGUI element provides a design property which content is passed as props the Quasar component:

ui.radio(['x', 'y', 'z'], design='inline color=green')
ui.button(icon='touch_app', design='outline round')

Have a look at the Quasar documentation for all styling "props".

Plots

To render a simple plot you create a new context and call the neccessary Matplotlib functions:

with ui.plot():
    x = np.linspace(0.0, 5.0)
    y = np.cos(2 * np.pi * x) * np.exp(-x)
    plt.plot(x, y, '-')
    plt.xlabel('time (s)')
    plt.ylabel('Damped oscillation')

To update a plot in regular intervals, have look at main.py.

To simplify live updating line plots even more, NiceGUI provides ui.line_plot with useful parameters and a push method:

lines = ui.line_plot(n=2, limit=20).with_legend(['sin', 'cos'], loc='upper center', ncol=2)
ui.timer(0.1, lambda: lines.push([datetime.now()], [
    [np.sin(datetime.now().timestamp()) + 0.02 * np.random.randn()],
    [np.cos(datetime.now().timestamp()) + 0.02 * np.random.randn()],
]))