【Streamlit】Streamlitのドキュメントを読み解く

こんにちは、JS2IIUです。
Streamlitについて最も情報が充実しているのは公式ドキュメントです。コードの実例と合わせて示されていて、とても実践的で役立つコンテンツになっています。公式ドキュメントの効果的な活用方法についてみていきます。今回もよろしくお願いします。

🔰 はじめに

Streamlit（ストリームリット）は、Pythonで手軽にWebアプリを作成できる強力なツールです。しかし、「Streamlitを使い始めたけれど、使いたい機能の情報が見つからない」「公式ドキュメントの読み方がわからない」という初心者の方も多いのではないでしょうか？

本記事では、Streamlitの公式ドキュメントを効果的に活用する方法を、具体的なコード例とともにステップバイステップで解説していきます。
「ドキュメントを読むのが苦手…」という方も、読み終わる頃には自信を持ってドキュメントを活用できるようになります！

📚 公式ドキュメントの構成をざっくり理解しよう

Streamlitの公式ドキュメントは以下のURLからアクセスできます：

🔗 https://docs.streamlit.io

Streamlit Docs

docs.streamlit.io

主なセクションは以下のとおりです：

🔍 ドキュメントを使ってコードを書いてみよう（実践例）

✅ 目標：CSVファイルを読み込んで中身を表示するアプリを作る

ドキュメントを活用しながら、CSVファイルをアップロード → 表示する簡単なアプリを作ってみましょう。

🧭 ステップ1：やりたいことを明確にする

やりたいことはこうです：

• ユーザーにCSVファイルをアップロードしてもらう
• ファイルの中身を表として表示する

このとき、「ファイルアップロードってどうやるんだろう？」と思ったら、ドキュメントでキーワードを検索しましょう。

🔍 ステップ2：ドキュメントでAPIを探す

Streamlitのトップページ右上の検索窓で「file」や「upload」などのキーワードを入れてみます。
すると st.file_uploader という関数が見つかります。

上記の検索する方法以外にも、メニューから選択する方法があります。探したいAPIのカテゴリがわかっている場合はこちらの方法がおすすめです。

st.file_uploader の公式説明（抜粋）

st.file_uploader(label, type=None, accept_multiple_files=False, …)
ユーザーがファイルをアップロードできるウィジェットを表示します。

使用例も載っていて、とても親切です。
次に、アップロードしたファイルを表で表示するには st.dataframe を使います。

✍️ ステップ3：コードを書いてみよう

import streamlit as st
import pandas as pd

st.title("CSVファイルのアップロードと表示")

# ファイルアップローダー
uploaded_file = st.file_uploader("CSVファイルを選択してください", type="csv")

# ファイルがアップロードされた場合
if uploaded_file is not None:
    # pandasで読み込む
    df = pd.read_csv(uploaded_file)

    # データフレームを表示
    st.subheader("CSVの中身を表示します")
    st.dataframe(df)

🧵 ステップ4：コードの解説

① st.file_uploader

uploaded_file = st.file_uploader("CSVファイルを選択してください", type="csv")

• ドキュメントを見ると、label（ラベル）とtype（ファイルの種類）を設定できることがわかります。
• type="csv" とすることでCSVファイルに限定できます。

② pd.read_csv

df = pd.read_csv(uploaded_file)

• uploaded_fileはBytesIO型なので、Pandasでそのまま読めます。
• pd.read_csv()はPandasの標準的な関数なので、データ分析にもよく使われます。

③ st.dataframe

st.dataframe(df)

• st.dataframe()は、スクロール・並べ替え可能な表を表示します。
• ドキュメントには「DataFrameや2次元リストを表示できる」と書かれています。

📌 ワンポイント：ドキュメントの便利な見方

公式ドキュメントでは、各関数のページに以下のような情報が載っています：

• 関数シグネチャ：どんな引数が使えるか
• 引数の説明：型、デフォルト値、用途など
• 使用例（Usage example）：実際のコード例
• 戻り値：関数の出力は何か

使いたい関数があったら「Usage example」セクションだけでも目を通すようにすると、使い方が一気にわかります。

⭐ よく使うページはブックマークしよう

初心者の方は以下のページをブックマークしておくと便利です：

🧩 よくあるつまずきと対処法

🎯 おわりに

公式ドキュメントは最初は難しく感じるかもしれませんが、慣れてくると「わからないことは全部ここにある」と思えるほど頼りになる存在です。

今回のように「やりたいこと」を意識しながら、ドキュメントでキーワードを探し、使い方を確認しながらコードを書くことで、自然とドキュメントを“読める力”が身についていきます。

ぜひ、次は他のAPI（st.form や st.tabs など）にもチャレンジしてみてください！

🔗 参考リンク

• 📘 Streamlit公式ドキュメント
• 🧾 Cheat Sheet PDF
• 🎨 Streamlit Gallery

最後まで読んでいただきありがとうございました。