requirements.txt の書き方|Bot に必要なライブラリをサーバーに入れる方法
手元のパソコンでは動くのに、サーバーに上げたら ModuleNotFoundError で動かない――その原因のほとんどは、必要なライブラリがサーバーに入っていないことです。このページでは、Python の Bot で使うライブラリを一覧にする requirements.txt の書き方と作り方、よくある失敗を説明します。
requirements.txt とは
Bot が使うライブラリの名前を1行に1つずつ書いたテキストファイルです。サーバーはこのファイルを読んで、起動前に必要なライブラリを自動でインストールします。
discord.py
python-dotenv
aiohttp
aiosqlite
ファイル名は必ず requirements.txt(すべて小文字・最後の s を忘れない)にして、main.py と同じフォルダに置きます。
何を書けばいいかの調べ方
コードの先頭の import を見ます。ただし、import の名前とインストールする名前が違うものがあるので注意してください。
| import の書き方 | requirements.txt に書く名前 |
import discord | discord.py |
|---|---|
from dotenv import load_dotenv | python-dotenv |
from PIL import Image | Pillow |
import yaml | PyYAML |
from bs4 import BeautifulSoup | beautifulsoup4 |
import cv2 | opencv-python-headless |
os・json・asyncio・random・datetime・sqlite3 などは Python に最初から入っているので、書く必要はありません。
手元の環境から自動で作る
pip freeze > requirements.txt
今の環境に入っているライブラリがすべて書き出されます。ただし、Bot に関係ないものまで大量に入ることがあるので、書き出したあとに不要な行を消すのがおすすめです。Bot 専用の仮想環境(venv)を作ってから実行すると、余計なものが入りません。
バージョンを指定する
discord.py>=2.3,<3
aiohttp==3.9.5
==:そのバージョンに固定>=:そのバージョン以上<:そのバージョン未満(大きな仕様変更を避ける)
手元で動いているバージョンに合わせておくと、「サーバーだけ新しいバージョンが入って動かない」というトラブルを防げます。
よくある失敗
discord と書いてしまう
discord という名前でも入りますが、古い別物です。必ず discord.py と書きます。
discord.py と py-cord・nextcord を一緒に書いている
これらはどれも import discord で読み込まれるため、同時に入れると壊れます。使うライブラリを1つだけにしてください。
ファイル名が Requirements.txt や requirement.txt になっている
サーバーは大文字と小文字を区別するので、読み込まれません。
ERROR: Could not find a version that satisfies the requirement
名前のつづり間違いか、そのバージョンが存在しない・サーバーの Python に対応していないことが原因です。
音声機能を使う
ボイスチャンネルを使う場合は discord.py[voice] と書きます。
StellaHost での使い方
- パネルの「ファイル」で、main.py と同じ場所に
requirements.txtをアップロード(または新規作成)します。 - サーバーを起動(再起動)すると、起動のたびに自動でライブラリがインストールされます。
- コンソールに
Successfully installed ...と出ていれば成功です。
まとめ
- 使うライブラリを1行ずつ
requirements.txtに書き、main.py と同じ場所に置く - import 名とインストール名が違うもの(discord → discord.py など)に注意
- 手元と同じバージョンを指定しておくとトラブルが減る
Discord Bot を、月 ¥180 で24時間。
支払い後およそ2分で、日本のサーバーが自動で用意されます。 プランを見る →