nicegui

Create web-based user interfaces with Python. The nice way.

https://github.com/zauberzeug/nicegui

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 2 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
4 of 171 committers (2.3%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.3%) to scientific vocabulary

Keywords

frontend gui interaction interface interfaces python robotics scripting toolkit webapp website

Keywords from Contributors

pydantic redoc asyncio meshing agents hack parallel interpretability json-schema python-types

Last synced: 4 months ago · JSON representation ·

Repository

Create web-based user interfaces with Python. The nice way.

Basic Info

Host: GitHub
Owner: zauberzeug
License: mit
Language: Python
Default Branch: main
Homepage: https://nicegui.io
Size: 75.2 MB

Statistics

Stars: 13,502
Watchers: 82
Forks: 809
Open Issues: 83
Releases: 0

Topics

frontend gui interaction interface interfaces python robotics scripting toolkit webapp website

Created over 4 years ago · Last pushed 4 months ago

Metadata Files

Readme Contributing Funding License Code of conduct Citation Security

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 conda-forge as well as GitHub.

Features

browser-based graphical user interface
implicit reload on code change
acts as webserver (accessed by the browser) or in native mode (eg. desktop window)
standard GUI elements like label, button, checkbox, switch, slider, input, file upload, ...
simple grouping with rows, columns, cards and dialogs
general-purpose HTML and Markdown elements
powerful high-level elements to
- plot graphs and charts,
- render 3D scenes,
- get steering events via virtual joysticks
- annotate and overlay images
- interact with tables
- navigate foldable tree structures
- embed video and audio files
built-in timer to refresh data in intervals (even every 10 ms)
straight-forward data binding and refreshable functions to write even less code
notifications, dialogs and menus to provide state of the art user interaction
shared and individual web pages
easy-to-use per-user and general persistence
ability to add custom routes and data responses
capture keyboard input for global shortcuts etc.
customize look by defining primary, secondary and accent colors
live-cycle events and session data
runs in Jupyter Notebooks and allows Python's interactive mode
auto-complete support for Tailwind CSS
SVG, Base64 and emoji favicon support
testing framework based on pytest

Installation

bash python3 -m pip install nicegui

Usage

Write your nice GUI in a file main.py:

```python from nicegui import ui

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

ui.run() ```

Launch it with:

bash 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 documentation is hosted at https://nicegui.io/documentation and provides plenty of live demos. The whole content of https://nicegui.io is implemented with NiceGUI itself and can be started locally with docker run -p 8080:8080 zauberzeug/nicegui or by executing main.py from this repository.

You may also have a look at our in-depth examples of what you can do with NiceGUI. In our wiki we have a list of great NiceGUI projects from the community, a section with Tutorials, a growing list of FAQs and some strategies for using ChatGPT / LLMs to get help about NiceGUI.

Why?

We at Zauberzeug 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.

Contributing

Thank you for your interest in contributing to NiceGUI! We are thrilled to have you on board and appreciate your efforts to make this project even better.

As a growing open-source project, we understand that it takes a community effort to achieve our goals. That's why we welcome all kinds of contributions, no matter how small or big they are. Whether it's adding new features, fixing bugs, improving documentation, or suggesting new ideas, we believe that every contribution counts and adds value to our project.

We have provided a detailed guide on how to contribute to NiceGUI in our CONTRIBUTING.md file. We encourage you to read it carefully before making any contributions to ensure that your work aligns with the project's goals and standards.

If you have any questions or need help with anything, please don't hesitate to reach out to us. We are always here to support and guide you through the contribution process.

Included Web Dependencies

See DEPENDENCIES.md for a list of web frameworks NiceGUI depends on.

Owner

Name: Zauberzeug GmbH
Login: zauberzeug
Kind: organization
Email: info@zauberzeug.com
Location: Münsterland, Germany

Website: www.zauberzeug.com
Repositories: 52
Profile: https://github.com/zauberzeug

Use magic. With intelligent software and robotics.

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it as below.
authors:
  - family-names: Schindler
    given-names: Falko
    orcid: https://orcid.org/0009-0003-5359-835X
  - family-names: Trappe
    given-names: Rodja
    orcid: https://orcid.org/0009-0009-4735-6227
title: "NiceGUI: Web-based user interfaces with Python. The nice way."
version: 2.23.3
date-released: "2025-08-26"
url: https://github.com/zauberzeug/nicegui
doi: 10.5281/zenodo.7785516
identifiers:
  - description: DOI for this application's record on Zenodo
    type: doi

Committers

Last synced: 7 months ago

All Time

Total Commits: 5,126
Total Committers: 171
Avg Commits per committer: 29.977
Development Distribution Score (DDS): 0.47

Past Year

Commits: 576
Committers: 69
Avg Commits per committer: 8.348
Development Distribution Score (DDS): 0.576

Top Committers

Name	Email	Commits
Falko Schindler	f**o@z**m	2,718
Rodja Trappe	r**a@z**m	1,557
github-actions[bot]	4****]	91
dependabot[bot]	4****]	80
Natan	n**m@g**m	75
Dominique CLAUSE	d**e@g**m	48
Christoph Trappe	c**e@g**e	41
Evan Chan	3****n	31
thetableman	7****n	24
Jacopo	1****e	20
frankvp11	f**3@g**m	20
Brian Landry	b**y@g**m	14
Hannes Römer	1****r	14
Diego Queiroz	d**g@g**m	13
Paula Kammler	p**a@z**m	13
Rino Beeli	4****i	12
Jaco Verster	v**e@g**m	11
Alejandro Gil	Z****1	10
Your Name	m**n@g**m	10
Jens Ogorek	j**k@g**m	10
CrystalWindSnake	5**5@q**m	9
David Kincaid	d**a@g**m	9
Adrian Ehrsam	a**m@b**h	9
Steve Jackson	s**n@g**m	9
angelisM	t**1@a**r	7
Stefan Gula	s**g@g**m	7
Michel Lavoie	l**l@g**m	7
Eli Khazan	3****r	7
Dronakurl	k**0@g**m	6
Itay Raveh	i**0@g**m	5
and 141 more...

Committer Domains (Top 20 + Academic)

zauberzeug.com: 4 qq.com: 4 yandex.ru: 2 fermigier.com: 1 gotev.net: 1 leftshift.one: 1 coterra.com: 1 butenkoms.space: 1 lancasterdhia.com: 1 tuta.io: 1 csiro.au: 1 shopify.com: 1 zoho.com: 1 aarhus.dk: 1 quantis.nl: 1 tmlmt.com: 1 nist.gov: 1 toptal.com: 1 mailbox.org: 1 aueb.gr: 1 uqconnect.edu.au: 1 diamond.ac.uk: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 872
Total pull requests: 1,517
Average time to close issues: 13 days
Average time to close pull requests: 9 days
Total issue authors: 503
Total pull request authors: 182
Average comments per issue: 3.09
Average comments per pull request: 2.02
Merged pull requests: 1,116
Bot issues: 2
Bot pull requests: 171

Past Year

Issues: 303
Pull requests: 660
Average time to close issues: 10 days
Average time to close pull requests: 8 days
Issue authors: 216
Pull request authors: 81
Average comments per issue: 2.52
Average comments per pull request: 2.42
Merged pull requests: 429
Bot issues: 1
Bot pull requests: 103

View more stats

Top Authors

Issue Authors

falkoschindler (63)
rodja (18)
natankeddem (13)
CrystalWindSnake (11)
v479038280 (11)
me21 (11)
kleynjan (10)
gavinpotter (9)
JS-Aibel (9)
Smug246 (9)
evnchn (8)
ghbm-itk (8)
sonicno1 (7)
zak-45 (6)
ruiheng (6)

Pull Request Authors

falkoschindler (383)
rodja (282)
dependabot[bot] (171)
evnchn (130)
codingpaula (25)
ZeroCool940711 (21)
natankeddem (16)
frankvp11 (15)
thetableman (15)
CrystalWindSnake (14)
Alyxion (12)
xaptronic (11)
tmlmt (9)
voigta (9)
python-and-fiction (9)

Top Labels

Issue Labels

bug (201) question (77) enhancement (46) help wanted (43) documentation (33) analysis (23) review (22) 🟡 medium (17) 🌿 intermediate (9) 🌳 advanced (9) ⚪️ minor (9) 🟠 major (8) dependencies (5) 🔴 critical (4) 🌱 beginner (4) waiting (3) testing (3) feature (2) python (2) blocked (2) in progress (1) wontfix (1) infrastructure (1)

Pull Request Labels

enhancement (491) bug (245) documentation (227) dependencies (180) review (157) python (139) feature (110) 🟡 medium (41) github_actions (36) ⚪️ minor (36) 🟠 major (31) 🌿 intermediate (30) analysis (27) 🌳 advanced (19) infrastructure (14) in progress (14) 🌱 beginner (13) testing (10) docker (8) question (7) 🔴 critical (6) help wanted (5) blocked (4) invalid (1)

Packages

Total packages: 2
Total downloads:
- pypi 349,006 last-month
Total docker downloads: 5,567

Total dependent packages: 44
(may contain duplicates)
Total dependent repositories: 24
(may contain duplicates)
Total versions: 576
Total maintainers: 1
Total advisories: 2

pypi.org: nicegui

Create web-based user interfaces with Python. The nice way.

Homepage: https://github.com/zauberzeug/nicegui
Documentation: https://nicegui.readthedocs.io/
License: MIT
Latest release: 2.23.3
published 4 months ago

Versions: 282
Dependent Packages: 44
Dependent Repositories: 24
Downloads: 349,006 Last month
Docker Downloads: 5,567

Rankings

Stargazers count: 0.4%

Dependent packages count: 1.6%

Downloads: 1.8%

Average: 2.0%

Dependent repos count: 3.0%

Forks count: 3.0%

Maintainers (1)

zauberzeug

Advisories (2)

Last synced: 4 months ago

proxy.golang.org: github.com/zauberzeug/nicegui

Documentation: https://pkg.go.dev/github.com/zauberzeug/nicegui#section-documentation
License: mit
Latest release: v2.23.3+incompatible
published 4 months ago

Versions: 294
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 4 months ago

Dependencies

.github/workflows/publish.yml actions

abatilo/actions-poetry v2.0.0 composite
actions/checkout v2 composite
actions/setup-python v2 composite
christian-korneck/update-container-description-action v1 composite
docker/build-push-action v2 composite
docker/login-action v1 composite
docker/setup-buildx-action master composite
docker/setup-qemu-action master composite
softprops/action-gh-release v1 composite

.github/workflows/test.yml actions

Gamesight/slack-workflow-status master composite
Jimdo/should-i-notify-action main composite
abatilo/actions-poetry v2.0.0 composite
actions/checkout v3 composite
actions/setup-python v4 composite
actions/upload-artifact v2 composite
nanasess/setup-chromedriver v2.1.1 composite

.devcontainer/Dockerfile docker

python 3.8 build

docker-compose.yml docker

traefik v2.3

examples/docker_image/docker-compose.yml docker

zauberzeug/nicegui latest

examples/nginx_subpath/docker-compose.yml docker

nginx 1.16.0-alpine
zauberzeug/nicegui 1.2.7

examples/ros2/Dockerfile docker

ros humble-ros-base build

examples/ros2/docker-compose.yml docker

examples/ai_interface/requirements.txt pypi

nicegui >=1.0
replicate >=0.4

examples/chat_with_ai/requirements.txt pypi

langchain >=0.0.142
nicegui *
openai *

examples/generate_pdf/requirements.txt pypi

nicegui *
pycairo *

examples/opencv_webcam/requirements.txt pypi

nicegui >=1.0
opencv-python >=4.0

examples/ros2/ros2_ws/src/gui/setup.py pypi

setuptools *

examples/ros2/ros2_ws/src/simulator/setup.py pypi

setuptools *

examples/simpy/requirements.txt pypi

nicegui >=1.2
simpy *

examples/sqlite_database/requirements.txt pypi

tortoise-orm *

nicegui

Science Score: 77.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

NiceGUI

Features

Installation

Usage

Documentation and Examples

Why?

Sponsors

Contributing

Included Web Dependencies

Owner

Citation (CITATION.cff)

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: nicegui

Rankings

Maintainers (1)

Advisories (2)

proxy.golang.org: github.com/zauberzeug/nicegui

Rankings

Dependencies