nicegui

NiceGUI

NiceGUI は、Web ブラウザに表示される、使いやすい Python ベースの UI フレームワークです。ボタン、ダイアログ、マークダウン、3D シーン、プロットなどを作成できます。

マイクロ Web アプリ、ダッシュボード、ロボット工学プロジェクト、スマート ホーム ソリューション、および同様のユースケースに最適です。また、機械学習アルゴリズムの微調整/構成やモーター コントローラーの調整など、開発でも使用できます。

NiceGUI は、PyPI パッケージ、Docker イメージとして、conda-forge および GitHub で入手できます。

特徴

• ブラウザベースのグラフィカル ユーザー インターフェイス
• コード変更時の暗黙的なリロード
• Webサーバー（ブラウザによってアクセスされる）またはネイティブモード（デスクトップウィンドウなど）として機能します。
• ラベル、ボタン、チェックボックス、スイッチ、スライダー、入力、ファイルアップロードなどの標準的な GUI 要素
• 行、列、カード、ダイアログによる簡単なグループ化
• 汎用の HTML 要素と Markdown 要素
• 強力な高レベルの要素
  • グラフやチャートをプロットする、
  • 3D シーンをレンダリングし、
  • 仮想ジョイスティック経由でステアリング イベントを取得する
  • 画像に注釈を付けてオーバーレイする
  • テーブルを操作する
  • 折りたたみ可能なツリー構造をナビゲートする
  • ビデオとオーディオファイルを埋め込む
• 一定間隔でデータを更新する内蔵タイマー (10 ミリ秒ごとでも)
• 簡単なデータ バインディングと更新可能な関数により、記述するコードがさらに少なくなります
• 最先端のユーザーインタラクションを提供する通知、ダイアログ、メニュー
• 共有および個別の Web ページ
• ユーザーごとの使いやすさと一般的な永続性
• カスタムルートとデータ応答を追加する機能
• グローバル ショートカットなどのキーボード入力をキャプチャします。
• プライマリカラー、セカンダリカラー、アクセントカラーを定義して外観をカスタマイズする
• ライブサイクルイベントとセッションデータ
• Jupyter Notebook で実行され、Python の対話モードが可能になります
• Tailwind CSS のオートコンプリートのサポート
• SVG、Base64、絵文字ファビコンのサポート
• pytestに基づくテストフレームワーク

インストール

python3 -m pip install nicegui

使用法

ファイルmain.pyに素敵な GUI を書きます。

 from nicegui import ui

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

ui . run ()

次のコマンドで起動します。

python3 main.py

GUI はブラウザの http://localhost:8080/ から利用できるようになりました。注: コードを変更すると、NiceGUI はページを自動的にリロードします。

ドキュメントと例

ドキュメントは https://nicegui.io/documentation でホストされており、豊富なライブ デモが提供されています。 https://nicegui.io のコンテンツ全体は NiceGUI 自体で実装されており、 docker run -p 8080:8080 zauberzeug/niceguiを使用してローカルで開始するか、このリポジトリからmain.py実行することで開始できます。

NiceGUI で何ができるかの詳細な例もご覧ください。私たちの Wiki には、コミュニティからの優れた NiceGUI プロジェクトのリスト、チュートリアルのセクション、増え続ける FAQ のリスト、および ChatGPT / LLM を使用して NiceGUI に関するヘルプを得る方法がいくつかあります。

なぜ？

私たち Zauberzeug は Streamlit が気に入っていますが、状態の処理に関しては魔法が多すぎると感じています。 Python でシンプルなグラフィカル ユーザー インターフェイスを作成するための代替の優れたライブラリを探していたところ、JustPy を発見しました。このアプローチは気に入っていましたが、日常的に使用するには「低レベルの HTML」すぎます。しかし、このことが私たちに Vue と Quasar をフロントエンドに使用するきっかけを与えました。

私たちは FastAPI をベースに構築しました。FastAPI 自体は、優れたパフォーマンスと使いやすさを備えた ASGI フレームワーク Starlette と ASGI Web サーバー Uvicorn に基づいています。

スポンサー

このプロジェクトの維持は、すべての貢献者とスポンサーのおかげで可能になっています。このプロジェクトをサポートし、あなたのアバターや会社のロゴを下に表示したい場合は、スポンサーになってください。 ?

このハードルの低い寄付形態をあなた自身でも検討してみてください。皆様のご支援をよろしくお願いいたします。

貢献する

NiceGUI への貢献にご興味をお持ちいただきありがとうございます。皆様にご参加いただけることを大変うれしく思います。また、このプロジェクトをより良いものにするための皆様のご尽力に感謝いたします。

成長を続けるオープンソース プロジェクトとして、私たちは目標を達成するにはコミュニティの努力が必要であることを理解しています。そのため、規模の大小を問わず、あらゆる種類の貢献を歓迎します。新しい機能の追加、バグの修正、ドキュメントの改善、新しいアイデアの提案など、あらゆる貢献が重要であり、プロジェクトに付加価値を与えると私たちは信じています。

COTRIBUTING.md ファイルには、NiceGUI に貢献する方法に関する詳細なガイドが用意されています。あなたの作品がプロジェクトの目標と基準に沿っていることを確認するために、貢献する前にこれを注意深く読むことをお勧めします。

ご質問がある場合、または何かサポートが必要な場合は、お気軽にお問い合わせください。私たちは常にここにいて、寄付プロセスを通じてあなたをサポートし、ガイドします。

含まれる Web 依存関係

NiceGUI が依存する Web フレームワークのリストについては、DEPENDENCIES.md を参照してください。