|
@@ -2,11 +2,15 @@
|
|
|
|
|
|
<img src="https://raw.githubusercontent.com/zauberzeug/nicegui/main/sceenshots/ui-elements.png" width="300" align="right">
|
|
<img src="https://raw.githubusercontent.com/zauberzeug/nicegui/main/sceenshots/ui-elements.png" width="300" align="right">
|
|
|
|
|
|
-We like [Streamlit](https://streamlit.io/) but find it does too 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](https://justpy.io/). While too "low-level HTML" for our daily usage it provides a great basis for "NiceGUI".
|
|
|
|
|
|
+We like [Streamlit](https://streamlit.io/) but find it does too 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](https://justpy.io/).
|
|
|
|
+While too "low-level HTML" for our daily usage it provides a great basis for "NiceGUI".
|
|
|
|
|
|
## Purpose
|
|
## Purpose
|
|
|
|
|
|
-NiceGUI is intended to be used for small scripts and single-page user interfaces with a very limited user base. Like smart home solutions, micro web apps or robotics projects. It's also helpful for development, when tweaking/configuring a machine learning training or tuning motor controllers.
|
|
|
|
|
|
+NiceGUI is intended to be used for small scripts and single-page user interfaces with a very limited user base.
|
|
|
|
+Like smart home solutions, micro web apps or robotics projects.
|
|
|
|
+It's also helpful for development, when tweaking/configuring a machine learning training or tuning motor controllers.
|
|
|
|
|
|
## Features
|
|
## Features
|
|
|
|
|
|
@@ -19,7 +23,7 @@ NiceGUI is intended to be used for small scripts and single-page user interfaces
|
|
- built-in timer to refresh data in intervals (even every 10 ms)
|
|
- built-in timer to refresh data in intervals (even every 10 ms)
|
|
- straight-forward data binding to write even less code
|
|
- straight-forward data binding to write even less code
|
|
|
|
|
|
-## Install
|
|
|
|
|
|
+## Installation
|
|
|
|
|
|
```bash
|
|
```bash
|
|
python3 -m pip install nicegui
|
|
python3 -m pip install nicegui
|
|
@@ -42,18 +46,21 @@ Launch it with:
|
|
python3 main.py
|
|
python3 main.py
|
|
```
|
|
```
|
|
|
|
|
|
-The GUI is now avaliable through http://localhost/ in your browser. Note: The script will automatically reload the page when you modify the code.
|
|
|
|
|
|
+The GUI is now avaliable through http://localhost/ in your browser.
|
|
|
|
+Note: The script will automatically reload the page when you modify the code.
|
|
|
|
|
|
## Docker
|
|
## Docker
|
|
|
|
|
|
-Use the [multi-arch docker image](https://hub.docker.com/repository/docker/zauberzeug/nicegui) for pain free installation:
|
|
|
|
|
|
+Use the [multi-arch docker image](https://hub.docker.com/repository/docker/zauberzeug/nicegui) for pain-free installation:
|
|
|
|
|
|
```bash
|
|
```bash
|
|
docker run --rm -p 8888:80 -v $(pwd)/my_script.py:/app/main.py -it zauberzeug/nicegui:latest
|
|
docker run --rm -p 8888:80 -v $(pwd)/my_script.py:/app/main.py -it zauberzeug/nicegui:latest
|
|
```
|
|
```
|
|
|
|
|
|
-This will start the server at http://localhost:8888 with code from `my_script.py` within the current directory. Code modification trigger an automatic reload.
|
|
|
|
|
|
+This will start the server at http://localhost:8888 with code from `my_script.py` within the current directory.
|
|
|
|
+Code modification triggers an automatic reload.
|
|
|
|
|
|
## API
|
|
## API
|
|
|
|
|
|
-The API reference is hosted at [https://nicegui.io](https://nicegui.io) and is [implemented with NiceGUI itself](https://github.com/zauberzeug/nicegui/blob/main/main.py). You should also have a look at [examples.py](https://github.com/zauberzeug/nicegui/tree/main/examples.py) for an extensive demonstration of what you can do with NiceGUI.
|
|
|
|
|
|
+The API reference is hosted at [https://nicegui.io](https://nicegui.io) and is [implemented with NiceGUI itself](https://github.com/zauberzeug/nicegui/blob/main/main.py).
|
|
|
|
+You should also have a look at [examples.py](https://github.com/zauberzeug/nicegui/tree/main/examples.py) for an extensive demonstration of what you can do with NiceGUI.
|