nicegui

NiceGUI

NiceGUI é uma estrutura de UI baseada em Python fácil de usar, que aparece em seu navegador da web. Você pode criar botões, diálogos, Markdown, cenas 3D, gráficos e muito mais.

É ótimo para microaplicativos web, painéis, projetos de robótica, soluções domésticas inteligentes e casos de uso semelhantes. Você também pode usá-lo no desenvolvimento, por exemplo, ao ajustar/configurar um algoritmo de aprendizado de máquina ou ajustar controladores de motor.

NiceGUI está disponível como pacote PyPI, imagem Docker e no conda-forge, bem como no GitHub.

Características

• interface gráfica de usuário baseada em navegador
• recarga implícita na mudança de código
• atua como servidor web (acessado pelo navegador) ou em modo nativo (ex. janela desktop)
• elementos padrão da GUI, como rótulo, botão, caixa de seleção, switch, controle deslizante, entrada, upload de arquivo, ...
• agrupamento simples com linhas, colunas, cartões e caixas de diálogo
• elementos HTML e Markdown de uso geral
• elementos poderosos de alto nível para
  • traçar gráficos e tabelas,
  • renderizar cenas 3D,
  • obtenha eventos de direção por meio de joysticks virtuais
  • anotar e sobrepor imagens
  • interagir com tabelas
  • navegar em estruturas de árvores dobráveis
  • incorporar arquivos de vídeo e áudio
• temporizador integrado para atualizar dados em intervalos (mesmo a cada 10 ms)
• vinculação de dados direta e funções atualizáveis ​​para escrever ainda menos código
• notificações, caixas de diálogo e menus para fornecer interação de usuário de última geração
• páginas da web compartilhadas e individuais
• fácil de usar por usuário e persistência geral
• capacidade de adicionar rotas personalizadas e respostas de dados
• capture a entrada do teclado para atalhos globais, etc.
• personalize a aparência definindo cores primárias, secundárias e de destaque
• eventos de ciclo ao vivo e dados de sessão
• roda em Jupyter Notebooks e permite o modo interativo do Python
• suporte de preenchimento automático para Tailwind CSS
• Suporte para SVG, Base64 e emoji favicon
• estrutura de teste baseada em pytest

Instalação

python3 -m pip install nicegui

Uso

Escreva sua bela GUI em um arquivo main.py :

 from nicegui import ui

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

ui . run ()

Inicie-o com:

python3 main.py

A GUI agora está disponível em http://localhost:8080/ no seu navegador. Nota: NiceGUI recarregará automaticamente a página quando você modificar o código.

Documentação e exemplos

A documentação está hospedada em https://nicegui.io/documentation e oferece muitas demonstrações ao vivo. Todo o conteúdo de https://nicegui.io é implementado com o próprio NiceGUI e pode ser iniciado localmente com docker run -p 8080:8080 zauberzeug/nicegui ou executando main.py deste repositório.

Você também pode dar uma olhada em nossos exemplos detalhados do que você pode fazer com o NiceGUI. Em nosso wiki temos uma lista de grandes projetos NiceGUI da comunidade, uma seção com Tutoriais, uma lista crescente de FAQs e algumas estratégias para usar ChatGPT/LLMs para obter ajuda sobre NiceGUI.

Por que?

Nós da Zauberzeug gostamos do Streamlit, mas achamos que ele faz muita mágica quando se trata de manipulação de estado. Em busca de uma biblioteca alternativa agradável para escrever interfaces gráficas de usuário simples em Python, descobrimos JustPy. Embora tenhamos gostado da abordagem, ela é muito “HTML de baixo nível” para nosso uso diário. Mas nos inspirou a usar Vue e Quasar para o frontend.

Construímos sobre FastAPI, que é baseado na estrutura ASGI Starlette e no servidor web ASGI Uvicorn devido ao seu excelente desempenho e facilidade de uso.

Patrocinadores

A manutenção deste projeto é possibilitada por todos os colaboradores e patrocinadores. Se você gostaria de apoiar este projeto e ter seu avatar ou logotipo da empresa aparecendo abaixo, por favor, patrocine-nos. ?

Considere você mesmo esta forma de contribuição de baixa barreira. Seu apoio é muito apreciado.

Contribuindo

Obrigado pelo seu interesse em contribuir com NiceGUI! Estamos entusiasmados por ter você a bordo e agradecemos seus esforços para tornar este projeto ainda melhor.

Como um projeto de código aberto em crescimento, entendemos que é necessário um esforço da comunidade para atingir nossos objetivos. É por isso que acolhemos todos os tipos de contribuições, não importa quão pequenas ou grandes sejam. Seja adicionando novos recursos, corrigindo bugs, melhorando a documentação ou sugerindo novas ideias, acreditamos que cada contribuição conta e agrega valor ao nosso projeto.

Fornecemos um guia detalhado sobre como contribuir com o NiceGUI em nosso arquivo CONTRIBUTING.md. Encorajamos você a lê-lo com atenção antes de fazer qualquer contribuição para garantir que seu trabalho esteja alinhado com os objetivos e padrões do projeto.

Se você tiver alguma dúvida ou precisar de ajuda com alguma coisa, não hesite em nos contatar. Estamos sempre aqui para apoiar e orientar você durante o processo de contribuição.

Dependências da Web incluídas

Consulte DEPENDENCIES.md para obter uma lista de estruturas da web das quais NiceGUI depende.