nicegui

NiceGUI

NiceGUI is an easy-to-use, Python-based UI framework, which shows up in your web browser. You can create buttons, dialogs, markdown, 3D scenes, plots and much more.

It is great for micro web apps, dashboards, robotics projects, smart home solutions and similar use cases. You can also use it in development, for example when tweaking/configuring a machine learning algorithm or tuning motor controllers.

NiceGUI is available as PyPI package, Docker image and on GitHub.

Features

Interaction

• buttons, switches, sliders, inputs, ...
• notifications, dialogs and menus
• keyboard input
• on-screen joystick

Layout

• navigation bars, tabs, panels, ...
• grouping with rows, columns and cards
• HTML and markdown elements
• flex layout by default

Visualization

• charts, diagrams and tables
• 3D scenes
• progress bars
• built-in timer for data refresh

Styling

• customizable color themes
• custom CSS and classes
• modern look with material design
• built-in Tailwind support

Coding

• live-cycle events
• implicit reload on code change
• straight-forward data binding
• execute javascript from Python

Foundation

• generic Vue to Python bridge
• dynamic GUI through Quasar
• content is served with FastAPI
• Python 3.7+

Installation

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: ui.notify('button was pressed'))

ui.run()

Launch it with:

python3 main.py

The GUI is now available through http://localhost:8080/ in your browser. Note: NiceGUI will automatically reload the page when you modify the code.

Documentation and Examples

The API reference is hosted at https://nicegui.io/reference and provides plenty of live examples. The whole content of https://nicegui.io is implemented with NiceGUI itself.

You may also have a look at the following examples for in-depth demonstrations of what you can do with NiceGUI:

• Slideshow: implements a keyboard-controlled image slideshow
• Authentication: shows how to use sessions to build a login screen
• Modularization: provides an example of how to modularize your application into multiple files and reuse code
• FastAPI illustrates the integration of NiceGUI with an existing FastAPI application
• Map: demonstrates wrapping the JavaScript library leaflet to display a map at specific locations
• AI User Interface: utilizes the replicate library to perform voice-to-text transcription and generate images from prompts with Stable Diffusion
• 3D Scene: creates a webGL view and loads an STL mesh illuminated with a spotlight
• Custom Vue Component shows how to write and integrate a custom Vue component
• Image Mask Overlay: shows how to overlay an image with a mask
• Infinite Scroll: presents an infinitely scrolling image gallery

Why?

We like Streamlit but find it does too much magic when it comes to state handling. In search for an alternative nice library to write simple graphical user interfaces in Python we discovered JustPy. Although we liked the approach, it is too "low-level HTML" for our daily usage. But it inspired us to use Vue and Quasar for the frontend.

We have built on top of FastAPI, which itself is based on the ASGI framework Starlette and the ASGI webserver Uvicorn because of their great performance and ease of use.

Docker

You can use our multi-arch Docker image:

docker run --rm -p 8888:8080 -v $(pwd):/app/ -it zauberzeug/nicegui:latest

This will start the server at http://localhost:8888 with the code from your current directory. The file containing your ui.run(port=8080, ...) command must be named main.py. Code modification triggers an automatic reload.

Deployment

To deploy your NiceGUI app, you will need to execute your main.py (or whichever file contains your ui.run(...)) on your server infrastructure. You can either install the NiceGUI python package via pip on the server or use our pre-built Docker image which contains all necessary dependencies (see above). For example you can use this docker run command to start the script main.py in the current directory on port 80:

docker run -p 80:8080 -v $(pwd)/:/app/ -d --restart always zauberzeug/nicegui:latest

The example assumes main.py uses the port 8080 in the ui.run command (which is the default). The --restart always makes sure the container is restarted if the app crashes or the server reboots. Of course this can also be written in a Docker compose file:

nicegui:
  image: zauberzeug/nicegui:latest
  restart: always
  ports:
    - 80:8080
  volumes:
    - ./:/app/

You can provide SSL certificates directly using FastAPI. In production we also like using reverse proxies like Traefik or NGINX to handle these details for us. See our docker-compose.yml as an example.