こんにちは、JS2IIUです。
Streamlitは、Pythonでデータアプリケーションを簡単に作成できる強力なライブラリです。アプリを動作させたり、設定を変更したりする際には、Streamlitのコマンドラインインターフェース（CLI）を活用すると便利です。本記事では、Streamlit CLIの基本的な使い方や、主要なコマンドとその意味について詳しく解説します。今回もよろしくお願いします。
1. Streamlit CLIとは？
Streamlit CLI（コマンドラインインターフェース）は、ターミナルやコマンドプロンプトから直接Streamlitの操作を行うためのツールです。CLIを使うことで、アプリの実行や設定変更、キャッシュのクリア、ドキュメントの参照などが簡単にできます。
CLIを利用することで、以下のようなメリットがあります。
- スムーズなアプリ開発：コードを編集したら即座に再実行できる。
- 簡単なデバッグ：エラーメッセージを即座に確認できる。
- カスタマイズ性の向上：設定の変更やキャッシュの管理が容易になる。
それでは、具体的なCLIコマンドを見ていきましょう。
2. Streamlitの基本コマンド
2.1 アプリの実行
Streamlitで作成したアプリを実行するには、streamlit run コマンドを使用します。
streamlit run your_script.pyこのコマンドを実行すると、Streamlitがローカルサーバーを立ち上げ、指定したPythonスクリプト（your_script.py）を実行します。ブラウザが自動的に開き、アプリが表示されます。
オプション：
--server.port XXXX：サーバーを特定のポートで起動（例：--server.port 8502）--server.headless true：ヘッドレスモード（GUIなし）で実行
実行例：
streamlit run app.py --server.port 85022.2 サンプルアプリの起動
Streamlitの基本機能を試したい場合は、streamlit hello コマンドを使用すると、デモアプリが起動します。
streamlit helloこのコマンドを実行すると、Streamlitの主要機能を紹介するデモアプリが開きます。
2.3 設定オプションの確認
現在のStreamlitの設定を確認するには、streamlit config show コマンドを使用します。
streamlit config showこのコマンドを実行すると、Streamlitのすべての設定項目とその値が表示されます。
主な設定項目：
server.port：デフォルトのポート番号（8501）browser.gatherUsageStats：使用統計の収集を許可するか（true/false）
設定を変更したい場合は、~/.streamlit/config.toml ファイルを編集します。
2.4 キャッシュのクリア
Streamlitはパフォーマンス向上のためにデータをキャッシュしますが、キャッシュが不要になった場合は、以下のコマンドで削除できます。
streamlit cache clearこのコマンドを実行すると、保存されたキャッシュデータがすべて削除されます。
2.5 公式ドキュメントを開く
Streamlitの公式ドキュメントを参照するには、以下のコマンドを実行します。
streamlit docsこのコマンドを実行すると、デフォルトのブラウザで公式ドキュメントが開かれます。
2.6 Streamlitのバージョン確認
現在インストールされているStreamlitのバージョンを確認するには、以下のコマンドを使用します。
streamlit versionこのコマンドを実行すると、現在のバージョン番号が表示されます。
3. まとめ
本記事では、Streamlit CLIの基本的な使い方について詳しく解説しました。
streamlit run your_script.py：アプリの実行streamlit hello：デモアプリの起動streamlit config show：設定の確認streamlit cache clear：キャッシュのクリアstreamlit docs：公式ドキュメントの参照streamlit version：バージョン確認
Streamlit CLIを活用することで、より快適にアプリ開発ができます。ぜひ試してみてください！
最後に書籍のPRです。
24年9月に出版された「ハイパーモダンPython-信頼性の高いワークフローを構築するモダンテクニック」、Claudio Jolowicz著、嶋田、鈴木訳。開発環境の構築、プロジェクトの管理、テストに関して実践的な内容でとても参考になる一冊です。Poetryについても詳しく説明されています。ぜひ手に取ってみてください。
最後まで読んでいただきありがとうございます。
コメント