Python で Google Firebase の Realtime Database (リアルタイムデータベース), Google Firebase Storage を使ってみる(pyrebase を使用)

概要

Pyrebase4(pyrebase)を用いて,Python から Google Firebase の Realtime Database(リアルタイムデータベース)と Storage を操作する手順を解説する。Firebase プロジェクトの作成,認証情報の取得,Storage へのファイルのアップロード・ダウンロードまでを扱う。

目次

  1. 第1章 前準備
  2. 第2章 Python パッケージ Pyrebase4 のインストール方法
  3. 第3章 Realtime Database プロジェクトの作成手順
  4. 第4章 Firebase Storage の利用方法

関連する外部ページhttps://firebase.google.com/docs/web/setup

【サイト内の関連ページ】

Google Firebase 活用ガイド

第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)を選択する.

Git のインストール(Windows 上) [クリックして展開]

管理者権限コマンドプロンプトで以下を実行する.管理者権限は,winget の --scope machine オプションでシステム全体にインストールするために必要となる.

REM Git をシステム領域にインストール
winget install --scope machine --id Git.Git -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --override "/VERYSILENT /NORESTART /NOCANCEL /SP- /CLOSEAPPLICATIONS /RESTARTAPPLICATIONS /COMPONENTS=""icons,ext\reg\shellhere,assoc,assoc_sh"" /o:PathOption=Cmd /o:CRLFOption=CRLFCommitAsIs /o:BashTerminalOption=MinTTY /o:DefaultBranchOption=main /o:EditorOption=VIM /o:SSHOption=OpenSSH /o:UseCredentialManager=Enabled /o:PerformanceTweaksFSCache=Enabled /o:EnableSymlinks=Disabled /o:EnableFSMonitor=Disabled"

Python の仮想環境の作成

  1. これから作成するPython の仮想環境の名前とPythonのバージョンを設定する
  2. Windows のコマンドプロンプトを起動する.
  3. 事前に Python をインストールしておく.

    以下のコマンドを実行する.

    conda create -n pyrebase python=3.12
    
  4. Python 環境の作成を確認
    conda info -e
    

これにより,既存のPython環境と, 新しく作成したPython環境(Python のバージョン 3.12名前は pyrebase)が共存する環境が整った.

第2章 Python パッケージ Pyrebase4 のインストール方法

Python から Firebase を操作するために,Pyrebase の保守版である Pyrebase4(import 名は pyrebase)をインストールする。Pyrebase4 は現行の依存パッケージに対応しており,Python 3 で動作する(元の thisbejim/Pyrebase は更新が止まっており,現行環境では動作しない)。

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

  2. Pyrebase4 のインストール

    以下のコマンドを実行する。インストールの完了まで待機し,エラーメッセージが表示されていないことを確認する。

    pip install -U --no-user pyrebase4
    
  3. インストールの完了確認

    エラーメッセージが表示されていないことを確認する

第3章 Realtime Database プロジェクトの作成手順

  1. Firebase の公式サイトにアクセス

    https://firebase.google.com/?hl=ja

    Google アカウント(IDとパスワード)が必要となる

  2. コンソールへ移動」を選択
  3. プロジェクトを追加」を選択

    画面が応答しない場合は,Webブラウザでサインアウトし,再度ログインして試す

  4. プロジェクトの基本設定

    プロジェクト名: 識別しやすい任意の名前を設定

    アナリティクスと課金の地域: 日本を選択

    利用規約: 内容を確認し,同意できる場合のみチェック(同意できない場合は Firebase の利用を見送る)

  5. 次へ」を選択
  6. 設定内容の確認

    料金プランが「Spark プラン」(無料プラン)であることを確認し, データベースを利用するため「Database」を選択する

  7. Realtime Database を作成するため,「データベースを作成」を選択する
  8. セキュリティルールの設定

    開発環境での試用のため「テストモードで開始」を選択し,「有効にする」をクリックする

  9. データベースの作成完了を確認

    これでセットアップが完了した

第4章 Firebase Storage の利用方法

  1. Firebase にアクセス

    https://firebase.google.com/?hl=ja

  2. コンソールへ移動」を選択
  3. 利用するプロジェクトを選択
  4. Storage の設定

    Storage タブで「ルール」を以下のように設定する.

    注意:この設定ではファイルが公開される.個人情報や著作権のある素材は絶対にアップロードしないこと.

  5. プロジェクト設定の確認
  6. 認証情報の確認

    表示されるプロジェクトIDウェブAPIキーは後で使用するため,メモしておく

  7. Pythonでの実装

    IPythonpyrebase環境を使用する

    Anaconda3spyderの使用を推奨する.

    Windows では「spyder(pyrebase)」を選択する

    「spyder(pyrebase)」が存在しない場合は,仮想環境 pyrebase に spyder をインストールする(conda install -y -n pyrebase spyder)。

    メニューから起動できない場合は,コマンドプロンプトで以下を実行:

    conda activate pyrebase
    spyder
    

    以下のコードでファイルの操作が可能である.

    C:/image/126.pngは実在するファイルパスに変更する必要がある

    import pyrebase
    
    config = {
        'apiKey': '<ウェブAPIキー>',
        'authDomain': '<プロジェクトID>.firebaseapp.com',
        'databaseURL': 'https://<プロジェクトID>.firebaseio.com',
        'storageBucket': '<プロジェクトID>.appspot.com'
    }
    
    firebase = pyrebase.initialize_app(config)
    
    photo_path = 'C:/image/126.png'
    storage = firebase.storage()
    storage.child('image/126.png').put(photo_path)
    print( storage.child('image/126.png').get_url(None) )
    storage.child('image/126.png').download('image/126.png', 'C:/image/hoge.png')
    

    エラーが発生していないことを確認する

  8. アップロードの確認

    Firebase コンソールのStorage タブでファイルが正常にアップロードされていることを確認できる