Streamlit を用いたWEBアプリ

【概要】

Windows 上での Streamlit のインストールから、典型的なユーザインタフェース（文字表示、ボタン、フォーム、ファイル選択、画像表示）を作る演習までを説明する。

Streamlit は、Python だけで Web アプリのユーザインタフェース（GUI）を作るためのパッケージである。Streamlit で作ったプログラムは、ブラウザ上で動く Web アプリになる。Python スクリプトを streamlit run で起動すると、Streamlit が Web サーバを立ち上げ、ブラウザにページが開く。st.button()、st.text_input()、st.file_uploader() のように一行書くごとに UI 部品が画面に追加される。本記事では Python 3.12 を使用し、Windows 環境を前提とする。

Streamlit は、操作（ボタンを押す、文字を入力するなど）のたびにスクリプトを先頭から再実行して画面を更新する。これが Streamlit の基本的な動作の仕組みである。

Python プログラムの編集・実行には、Visual Studio Code の利用を推奨する（第1章参照）。

【目次】

【関連する外部ページ】

Streamlit 公式サイト: https://streamlit.io

Streamlit インストール手順: https://docs.streamlit.io/get-started/installation/command-line

ボタンの公式ドキュメント: https://docs.streamlit.io/develop/api-reference/widgets/st.button

テキスト入力の公式ドキュメント: https://docs.streamlit.io/develop/api-reference/widgets/st.text_input

ファイルアップロードの公式ドキュメント: https://docs.streamlit.io/develop/api-reference/widgets/st.file_uploader

画像表示の公式ドキュメント: https://docs.streamlit.io/develop/api-reference/media/st.image

【サイト内の関連情報】

Windows

pip

1. 前準備

Python 3.12 のインストール

Pythonのインストールを行い、Pythonのプログラムを実行する環境を整える。扱う環境は、Windows搭載パソコンである。金子研究室では、Python 3.12.10を推奨する。

[Windows での Python 3.12 のインストール手順を見るには、ここをクリック]

Windows での Python 3.12 のインストール

以下のいずれかの方法でPython 3.12をインストールする。Pythonがインストール済みの場合、この手順は不要である。

方法 1：winget によるインストール

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして、コマンド全体をコマンドプロンプトにコピー＆ペーストする。

--scope machine を指定することで、システム全体（全ユーザー向け）にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動するとPATHが反映される。

REM Python 3.12 をシステム領域にインストール
winget install --id Python.Python.3.12 -e --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_test=0 Include_pip=1 Include_launcher=1 InstallLauncherAllUsers=1 TargetDir=\"C:\Program Files\Python312\""

REM Python と Scripts を PATH 先頭に追加
powershell -NoProfile -Command "$p='C:\Program Files\Python312'; $s=\"$p\Scripts\"; $c=[Environment]::GetEnvironmentVariable('Path','Machine'); if((Test-Path $p) -and (';'+$c+';' -notlike \"*;$p;*\") -and (';'+$c+';' -notlike \"*;$s;*\")){[Environment]::SetEnvironmentVariable('Path',\"$p;$s;$c\",'Machine')}"

方法 2：インストーラーによるインストール

  1. Python公式サイト（https://www.python.org/downloads/）にアクセスし、「Download Python 3.x.x」ボタンからWindows用インストーラーをダウンロードする。
  2. ダウンロードしたインストーラーを実行する。
  3. 初期画面の下部に表示される「Add python.exe to PATH」にチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから python コマンドを実行できない。
  4. 「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。

インストールの確認

コマンドプロンプトで以下を実行する。

python --version

バージョン番号（例：Python 3.12.x）が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

Python の開発環境 Visual Studio Code のインストールと Python 用の設定

Python の開発環境Visual Studio Code（プログラムを編集するソフトウェア。以下、VS Code）を整える。

[Windows での Visual Studio Code のインストールと Python 用の設定手順を見るには、ここをクリック]

Windows での Visual Studio Code のインストールと Python 用の設定手順

1. VS Code と拡張機能のインストール

以下のコマンドにより，既存の VS Code を削除し，全ユーザー共有の設定で再インストールしたうえで，拡張機能（VS Code に機能を追加するソフトウェア）をまとめて導入する．

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windows キーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして，コマンド全体をコマンドプロンプトにコピー＆ペーストする。

インストールコマンド


REM ============================================================
REM Microsoft Visual Studio Code
REM ============================================================
winget uninstall -e --id Microsoft.VisualStudioCode --silent --disable-interactivity --accept-source-agreements
rmdir /s /q C:\ProgramData\vscode-extensions 2>nul
rmdir /s /q "%APPDATA%\Code" 2>nul
rmdir /s /q "%USERPROFILE%\.vscode" 2>nul
rmdir /s /q "%LOCALAPPDATA%\Microsoft\vscode-update" 2>nul

REM VS Code をシステム領域に新規インストール
winget install --scope machine --id Microsoft.VisualStudioCode -e --silent --accept-source-agreements --accept-package-agreements

REM 全ユーザー共有の拡張機能フォルダ
mkdir C:\ProgramData\vscode-extensions 2>nul
icacls "C:\ProgramData\vscode-extensions" /grant "Everyone:(OI)(CI)M" /T

REM スタートメニューのショートカットを --extensions-dir 付きで再作成
rmdir /s /q "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code" 2>nul
del "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk" 2>nul
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); $lnk.TargetPath='C:\Program Files\Microsoft VS Code\Code.exe'; $lnk.Arguments='--extensions-dir \"C:\ProgramData\vscode-extensions\"'; $lnk.Save()"
REM ショートカットの検証
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); Write-Host 'TargetPath:' $lnk.TargetPath; Write-Host 'Arguments:' $lnk.Arguments"

REM ファイル / フォルダ右クリックの「Code で開く」を登録
reg add "HKLM\SOFTWARE\Classes\*\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\Background\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%V\"" /f

REM --extensions-dir 付きで起動する code.cmd ラッパを作成
REM （%* を echo で書くと対話的 cmd で失われるため、PowerShell で [char]37+'*' を書き出す）
powershell -NoProfile -Command "$pct=[char]37; $q=[char]34; $c='@echo off'+[char]13+[char]10+$q+'C:\Program Files\Microsoft VS Code\bin\code.cmd'+$q+' --extensions-dir '+$q+'C:\ProgramData\vscode-extensions'+$q+' '+$pct+'*'+[char]13+[char]10; [IO.File]::WriteAllText('C:\ProgramData\vscode-extensions\vscode.cmd',$c,[Text.Encoding]::ASCII)"

REM 拡張機能のインストール
set "CODE=C:\Program Files\Microsoft VS Code\bin\code.cmd"
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot-chat
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.python
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.vscode-pylance
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.debugpy
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension MS-CEINTL.vscode-language-pack-ja
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension saoudrizwan.claude-dev
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension rust-lang.rust-analyzer
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension tamasfe.even-better-toml
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension anthropic.claude-code
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension almenon.arepl
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --list-extensions --show-versions
echo === セットアップ完了 ===

2. Python インタプリタの選択

同一マシンに複数の Python がインストールされている場合，VS Code で使用する Python 本体（インタプリタ：Python プログラムを解釈・実行するソフトウェア）を選択する必要がある．

  1. コマンドパレット（コマンド名で機能を呼び出す VS Code の入力欄）を開く（Ctrl+Shift+P）
  2. Python: Select Interpreter と入力する
  3. 表示される一覧から，使用する Python（例：C:\Program Files\Python312\python.exe）を選択する．

Python プログラム実行手順

[Windows での Python プログラム実行手順を見るには、ここをクリック]

Windows での Python 実行手順（Visual Studio Codeを使用）

プログラムファイルの作成と保存

  1. 左サイドバーの「エクスプローラー」アイコン（Ctrl+Shift+E）をクリックする
  2. 「NO FOLDER OPENED」（作業対象フォルダが未選択の状態）と表示される場合は，「Open Folder」をクリックし，プログラムを保存するフォルダを選択する

    続いて「フォルダを信用するか」を確認する画面（フォルダ内のコードを実行してよいか確認する VS Code の仕組み）が表示されるので，チェックして Yes を選択する

  3. フォルダ名の右側に表示される「新しいファイル」アイコンをクリックする
  4. ファイル名（例：aitask.py．ファイル名は何でも良い）を入力し Enter を押す．拡張子は .py（Python ファイルを示す拡張子）とする
  5. 実行したいコードを選択し，Ctrl+C でコピーする．VS Code のエディタ領域に Ctrl+V で貼り付ける
  6. Ctrl+S で保存する

プログラムの実行

  1. エディタ右上の三角形「▷」アイコン（Run Python File：現在開いている Python ファイルを実行するボタン）をクリックする．または，エディタ上で右クリックし「ターミナルで Python ファイルを実行」を選択する
  2. VS Code 下部のターミナル（コマンドの入出力を表示する画面）に，実行結果（print 関数の出力等）が表示される
  3. tkinter（Python 標準の GUI ライブラリ）のファイル選択ダイアログを使うプログラムを実行した場合は，ダイアログが開くので対象画像を選択する
  4. VS Code 下部のターミナルで実行結果を確認する．OpenCV ウィンドウ（OpenCV が画像を表示するために開く専用ウィンドウ）が開いた場合はそちらも確認する．OpenCV ウィンドウは，マウスクリックでウィンドウをアクティブ（操作対象の状態）にしてからキーを押すと終了する

2. Streamlit のインストール

管理者権限でコマンドプロンプトを起動する （手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。

システム全体の Python 環境に書き込むため、管理者権限が必要である。

Streamlit をインストールする。

python -m pip install -U --no-user streamlit

3. 演習1：文字の表示（動作確認）

テーマ名：Streamlit のインストール確認と、ブラウザに文字を表示する

手順：次のコードを実行する（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）。保存したファイルを、コマンドプロンプトで streamlit run に続けてファイル名を指定して起動する。ブラウザが自動で開き、ページに「Hello, Streamlit」と表示されれば、インストールは正常に完了している。終了するにはコマンドプロンプトで Ctrl+C を押す。

import streamlit as st

st.title("Hello, Streamlit")
st.write("これは Streamlit で作った Web アプリです。")

ヒント：streamlit run で起動すると、Streamlit が Web サーバを立ち上げ、ブラウザにページが開く。st.title() で見出し、st.write() で本文が表示される。

考察ポイント：独立したウィンドウではなくブラウザのページとして開くこと、ブラウザのアドレス欄が localhost（自分のPC）を指していることを確認する。これが Web アプリである証拠である。

4. 演習2：ボタンとイベント処理

テーマ名：ボタンの配置と、押したときの処理（イベント処理）

手順：次のコードを実行する（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）。保存したファイルを、コマンドプロンプトで streamlit run に続けてファイル名を指定して起動する。ブラウザにボタンが表示され、押すと下にメッセージが表示される。終了するにはコマンドプロンプトで Ctrl+C を押す。

import streamlit as st

st.title("ボタンの演習")

if st.button("押してください"):
    st.write("ボタンが押されました。")
else:
    st.write("ボタンはまだ押されていません。")

ヒント：st.button() は、ボタンが押された瞬間の再実行でのみ True を返す。Streamlit は操作のたびにスクリプトを先頭から再実行するので、if st.button(...) の中に、押されたときの処理を書く。

考察ポイント：ボタンを押したときだけメッセージが変わること、操作のたびにスクリプト全体が再実行されることを観察する。

5. 演習3：フォーム（テキスト入力）

テーマ名：テキスト入力欄とボタンによるフォーム

手順：次のコードを実行する（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）。保存したファイルを、コマンドプロンプトで streamlit run に続けてファイル名を指定して起動する。ブラウザにテキスト入力欄とボタンが表示される。入力欄に文字を打ってボタンを押すと、入力した文字がページに表示される。終了するにはコマンドプロンプトで Ctrl+C を押す。

import streamlit as st

st.title("フォームの演習")

name = st.text_input("名前を入力してください")

if st.button("送信"):
    st.write("入力された文字:", name)

ヒント：st.text_input() は、入力欄に打たれた文字を文字列として返す。返り値を変数で受け取り、ボタンが押されたときにその変数を表示する。

考察ポイント：入力した文字が変数から取り出せるか、入力欄を書き換えるとスクリプトが再実行されて画面が更新されることを観察する。

6. 演習4：ファイル選択（アップロード）

テーマ名：ファイル選択部品（ファイルアップローダ）でファイルを選ぶ

手順：次のコードを実行する（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）。保存したファイルを、コマンドプロンプトで streamlit run に続けてファイル名を指定して起動する。ブラウザにファイル選択部品が表示される。ファイルを選ぶと、選んだファイルの名前とサイズがページに表示される。終了するにはコマンドプロンプトで Ctrl+C を押す。

import streamlit as st

st.title("ファイル選択の演習")

uploaded_file = st.file_uploader("ファイルを選んでください")

if uploaded_file is not None:
    st.write("ファイル名:", uploaded_file.name)
    st.write("サイズ（バイト）:", uploaded_file.size)

ヒント：st.file_uploader() は、ファイルが選ばれていないときは None を、選ばれているときはファイルを表すオブジェクトを返す。そのため if uploaded_file is not None: で、選ばれているときだけ処理する。返り値の .name でファイル名、.size でサイズが得られる。

考察ポイント：ファイルを選ぶ前と後で表示がどう変わるか、ブラウザの部品からPC上のファイルを選べることを観察する。

7. 演習5：画像の表示

テーマ名：選んだ画像ファイルをブラウザに表示する

手順：次のコードを実行する（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）。保存したファイルを、コマンドプロンプトで streamlit run に続けてファイル名を指定して起動する。ブラウザに画像選択部品が表示される。画像ファイル（png や jpg）を選ぶと、その画像がページに表示される。終了するにはコマンドプロンプトで Ctrl+C を押す。

import streamlit as st

st.title("画像表示の演習")

uploaded_file = st.file_uploader("画像ファイルを選んでください", type=["png", "jpg", "jpeg"])

if uploaded_file is not None:
    st.image(uploaded_file, caption="選んだ画像")

ヒント：st.file_uploader() の type に拡張子のリストを渡すと、選べるファイルを画像だけに絞れる。返り値のファイルオブジェクトを st.image() に渡すと、その画像がブラウザに表示される。caption で画像に説明文を付けられる。

考察ポイント：選んだ画像がブラウザにそのまま表示されること、type で指定した拡張子以外が選びにくくなることを観察する。

8. まとめ