nicegui

Bonita GUI

NiceGUI es un marco de interfaz de usuario basado en Python fácil de usar, que aparece en su navegador web. Puede crear botones, cuadros de diálogo, Markdown, escenas 3D, gráficos y mucho más.

Es ideal para microaplicaciones web, paneles de control, proyectos de robótica, soluciones para hogares inteligentes y casos de uso similares. También puede usarlo en desarrollo, por ejemplo, al ajustar/configurar un algoritmo de aprendizaje automático o al ajustar controladores de motor.

NiceGUI está disponible como paquete PyPI, imagen de Docker y en conda-forge, así como en GitHub.

Características

• interfaz gráfica de usuario basada en navegador
• recarga implícita en el cambio de código
• actúa como servidor web (al que se accede mediante el navegador) o en modo nativo (por ejemplo, ventana de escritorio)
• elementos estándar de la GUI como etiqueta, botón, casilla de verificación, interruptor, control deslizante, entrada, carga de archivos, ...
• agrupación simple con filas, columnas, tarjetas y cuadros de diálogo
• elementos HTML y Markdown de uso general
• poderosos elementos de alto nivel para
  • trazar gráficos y tablas,
  • renderizar escenas 3D,
  • obtener eventos de dirección a través de joysticks virtuales
  • anotar y superponer imágenes
  • interactuar con mesas
  • navegar por estructuras de árboles plegables
  • incrustar archivos de vídeo y audio
• Temporizador incorporado para actualizar datos en intervalos (incluso cada 10 ms)
• enlace de datos sencillo y funciones actualizables para escribir aún menos código
• Notificaciones, cuadros de diálogo y menús para proporcionar interacción de usuario de última generación.
• páginas web compartidas e individuales
• fácil de usar por usuario y persistencia general
• capacidad de agregar rutas personalizadas y respuestas de datos
• capturar la entrada del teclado para atajos globales, etc.
• personalizar la apariencia definiendo colores primarios, secundarios y de acento
• eventos de ciclo en vivo y datos de sesión
• se ejecuta en Jupyter Notebooks y permite el modo interactivo de Python
• soporte de autocompletar para Tailwind CSS
• Compatible con SVG, Base64 y favicon emoji
• marco de prueba basado en pytest

Instalación

python3 -m pip install nicegui

Uso

Escribe tu bonita GUI en un archivo main.py :

 from nicegui import ui

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

ui . run ()

Lánzalo con:

python3 main.py

La GUI ahora está disponible a través de http://localhost:8080/ en su navegador. Nota: NiceGUI recargará automáticamente la página cuando modifique el código.

Documentación y ejemplos

La documentación está alojada en https://nicegui.io/documentation y proporciona muchas demostraciones en vivo. Todo el contenido de https://nicegui.io se implementa con el propio NiceGUI y se puede iniciar localmente con docker run -p 8080:8080 zauberzeug/nicegui o ejecutando main.py desde este repositorio.

También puede echar un vistazo a nuestros ejemplos detallados de lo que puede hacer con NiceGUI. En nuestra wiki tenemos una lista de excelentes proyectos NiceGUI de la comunidad, una sección con tutoriales, una lista creciente de preguntas frecuentes y algunas estrategias para usar ChatGPT/LLM para obtener ayuda sobre NiceGUI.

¿Por qué?

En Zauberzeug nos gusta Streamlit, pero consideramos que hace demasiada magia cuando se trata de manejo de estados. En la búsqueda de una buena biblioteca alternativa para escribir interfaces gráficas de usuario simples en Python, descubrimos JustPy. Aunque nos gustó el enfoque, es demasiado "HTML de bajo nivel" para nuestro uso diario. Pero nos inspiró a usar Vue y Quasar para la interfaz.

Hemos construido sobre FastAPI, que a su vez se basa en el marco ASGI Starlette y el servidor web ASGI Uvicorn debido a su gran rendimiento y facilidad de uso.

Patrocinadores

El mantenimiento de este proyecto es posible gracias a todos los contribuyentes y patrocinadores. Si desea apoyar este proyecto y que su avatar o logotipo de la empresa aparezca a continuación, patrocínenos. ?

Considere usted mismo esta forma de contribución de baja barrera. Su apoyo es muy apreciado.

Contribuyendo

¡Gracias por su interés en contribuir a NiceGUI! Estamos encantados de tenerlo a bordo y apreciamos sus esfuerzos para hacer que este proyecto sea aún mejor.

Como proyecto de código abierto en crecimiento, entendemos que se necesita un esfuerzo comunitario para lograr nuestros objetivos. Por eso damos la bienvenida a todo tipo de contribuciones, sin importar cuán pequeñas o grandes sean. Ya sea agregando nuevas funciones, corrigiendo errores, mejorando la documentación o sugiriendo nuevas ideas, creemos que cada contribución cuenta y agrega valor a nuestro proyecto.

Hemos proporcionado una guía detallada sobre cómo contribuir a NiceGUI en nuestro archivo CONTRIBUTING.md. Le recomendamos que lo lea detenidamente antes de realizar cualquier contribución para garantizar que su trabajo se alinee con los objetivos y estándares del proyecto.

Si tiene alguna pregunta o necesita ayuda con algo, no dude en comunicarse con nosotros. Siempre estamos aquí para apoyarlo y guiarlo a través del proceso de contribución.

Dependencias web incluidas

Consulte DEPENDENCIAS.md para obtener una lista de marcos web de los que depende NiceGUI.