PythonAnywhereでDjangoアプリをデプロイする時の流れとコツ

Last updated at 2024-08-03Posted at 2024-08-02

はじめに

この記事はwebアプリ初心者が「webにDjangoアプリをデプロイしてみたい！」という思いのもと、PythonAnywhereと格闘した記録を残そうといった趣旨のものになります。

基本的には公式ドキュメントの内容に準拠しておりますので下記ページもご一読ください！

PythonAnywhereとは

PythonAnywhereはブラウザ上でPythonプログラミングとウェブアプリケーションのホスティングができるクラウドサービスです。
コーディング、実行、デプロイが一か所で可能で、初心者にも使いやすい環境を提供してくれます。(by 生成AI.Claude)

PythonAnywhere

前提・環境

Python 3.10（PythonAnywhere）
Python 3.11.2（開発環境）
Django 5.0.7
PythonAnywhereライブラリは使わない
データベースはSQLite3
webアプリは作成済み
記事に使った画像のモザイク部はユーザー名

ディレクトリ構成

.
├── EmoRecord
│   ├── EmoRecord
│   │   ├── __init__.py
│   │   ├── admin.py
│   │   ├── apps.py
│   │   ├── forms.py
│   │   ├── migrations
│   │   ├── models.py
│   │   ├── static
│   │   │   ├── EmoRecord
│   │   │   │   └── style.css
│   │   │   ├── admin
│   │   │   │   ├── css
│   │   │   │   ├── img
│   │   │   │   └── js
│   │   │   └── favicon.ico
│   │   ├── templates
│   │   │   ├── EmoRecord
│   │   │   │   ├── base.html
│   │   │   │   ├── checkPast.html
│   │   │   │   ├── record.html
│   │   │   │   └── recordResult.html
│   │   │   └── login.html
│   │   ├── tests.py
│   │   ├── urls.py
│   │   └── views.py
│   ├── db.sqlite3
│   ├── manage.py
│   ├── mysite
│   │   ├── __init__.py
│   │   ├── asgi.py
│   │   ├── settings.py
│   │   ├── urls.py
│   │   └── wsgi.py
│   ├── requirements.txt
└── README.txt

Raspberry Pi 5で開発していたので、開発環境とデプロイ環境でPythonのバージョンが違っています。
デプロイ時に気づいたのですが、なんとか問題なく動きました…

1.webアプリ開発〜ファイルの移動

まずはwebアプリを作成しましょう！
(今回、僕はEmoRecordというアプリを作成しました)

作成過程は本題ではないので 割愛！

次にPythonAnywhereにてアカウントを作成し、「Console」タブからBashの立ち上げを行いましょう。
↓赤枠部をクリックしてください↓

クリックするとPythonAnywhereサーバ内でBashが立ち上がります。
ここで立ち上がるBashは一般的なBashと同じ使い心地なので、使ったことがない方は「Linux コマンド」などで検索してコマンドを入力してみましょう！

次にBashを使って、GitHubからPythonAnywhereサーバ内にwebアプリをコピーします。
このファイル移動に関しては諸兄が記事化してくれているので、またも割愛！！
僕は以下の記事にお世話になりました、ありがとうございます！！

Djangoで作成したWebアプリケーションを無料で公開する(PythonAnywhere)

なお、手順としてGitHubからファイルをcloneしてくるのですが、そのためにはGitHubのアクセストークンを作成して利用する必要があることに注意が必要です。
（下記記事が参考になりました、感謝！）

GithubでPersonal access tokens(アクセストークン)を設定してみた

また、事前にpip freezeでライブラリをrequirements.txtファイルに書き込んでおくと後で一括インストールする際に便利なのでぜひしておきましょう！

2.仮想環境の作成,ライブラリのインストール

次に、先程立ち上げたBash内で下記のコマンドを入力して仮想環境を作成しましょう。
「python3.10」の部分はwebアプリの開発環境で使用したPythonのバージョンに読み替えてください。

# python3.10の環境下で動作させたい場合
$ mkvirtualenv --python=/usr/bin/python3.10 [仮想環境名]

サーバ内で仮想環境を作成する理由は、複数のwebアプリをPythonAnywhereにてデプロイする場合に備え、依存関係コンフリクトが発生しないようにするためと思われます。
仮想環境が無事作成されると、コマンドラインの先頭に([仮想環境名])がつくようになります。

仮想環境を作成できたら、先程作成したrequirements.txtファイルを用いて下記コマンドでライブラリのインストールを行います。

([仮想環境名])$ pip install -r requirements.txt

インストールには少し時間がかかるので気長に待ちましょう。

3.webアプリとWSGIファイルの設定

ライブラリのインストールが無事完了したら、Bashは少しの間おやすみです。
次はPythonAnywhereサーバー内の設定ファイルを変更していきましょう。

まずは「Web」タブを開いて、新しいwebアプリの設定を行います。
↓赤枠部をクリックしてください↓

すると、以下のような選択画面が出てきますので、「Manual configuration」を選択してください。
（他の選択肢はサーバー内で新しくプロジェクトを一から立ち上げることになります）

後の選択肢は全て「Yes」や「Next」を選択すれば問題ありません。
Pythonのバージョンも聞かれるので、開発環境で使用したバージョンを答えましょう。

ここで僕は「詰んだ」と思いかけましたが、簡単なアプリだったので難を逃れました。怪我の功名。

サーバーに無事プロジェクトを設定できた場合、「Web」タブを開くとwebアプリの環境設定画面が見られるようになります。

↓こんな感じ↓

続いて、仮想環境名の指定を行います。
「web」タブページ中盤に「Virtualenv」の設定欄があるので、入力欄に先程作成した仮想環境の[仮想環境名]を入力しましょう。
僕は今回"EmoReco-venv"という名前の仮想環境を作成しました。

仮想環境ディレクトリのPathを入れてもいいですが、仮想環境名を入力するだけで勝手に検索＆変換してくれます。ありがたい！

次にPythonAnywhereサーバーのWSGIファイルの設定を行います。
同じく「Web」タブ内の中盤にある WSGI configuration file をDjangoアプリ用に編集していきましょう。

↓赤枠部をクリックしてください↓

ファイルを開くと各フレームワーク用の設定が記述されたコードが出てくるので、以下の「DJANGO」部分のみを残して他の部分は削除してしまいましょう。

/var/www/[ユーザー名]_pythonanywhere_com_wsgi.py

# +++++++++++ DJANGO +++++++++++
# To use your own Django app use code like this:
import os
import sys

# assuming your Django settings file is at '/home/myusername/mysite/mysite/settings.py'
path = '(①)'
if path not in sys.path:
    sys.path.insert(0, path)

os.environ['DJANGO_SETTINGS_MODULE'] = '(②).settings'

## Uncomment the lines below depending on your Django version
###### then, for Django >=1.5:
from django.core.wsgi import get_wsgi_application
application = get_wsgi_application()
###### or, for older Django <=1.4
#import django.core.handlers.wsgi
#application = django.core.handlers.wsgi.WSGIHandler()

削除できたら、コード中の①,②の部分を以下の内容に書き換えましょう！

①：manage.pyが存在するディレクトリのパス
　→今回であれば"/home/[ユーザー名]/EmoRecord"
②：settings.pyが存在するディレクトリ名
　→今回であれば"mysite"

なお確認の際は「Files」タブから実際にファイルが存在するパスを確認しながら入力すると確実です！

↓赤枠部が"manage.py"が存在するディレクトリのパス↓

4.データベースの設定, アプリ起動

ここまできたら後少し！
再びBashを立ち上げ、"manage.py"が存在するディレクトリまで移動しましょう。
移動したらおまじないとして、下記コマンドでマイグレーションを行います。

./manage.py migrate

続いて「web」タブにてReloadボタンを押し、設定した内容に間違いがなければ、無事サーバ状のwebアプリが動き出しているはずです…！

5.staticファイルの設定

さて、ここまで来て、実はまだ必要な作業が残っています。
現状の立ち上がったwebアプリを確認してもらうと、cssなどの静的ファイルが読み込まれず、かなり質素なUIが表示されているのではないでしょうか？？

これはまだPythonAnywhereサーバ内で静的ファイルのルーティングを行っていないことが原因なので、最後にちゃちゃっと片付けちゃいましょう！

まずは「web」タブを開き、「Static files」の設定を行いましょう。

ここが結構ハマりどころでした。
collectstaticコマンドを使用するなど過去記事や公式リファレンスを参考にアレコレ試したのですが、結果的に以下のように設定すれば良いものかと思われます。

URL：設定ファイル"setting.py"のSTATIC_URL変数に指定したURL名
Directory：PythonAnywhereサーバ内の実際に静的ファイルが置かれているディレクトリ名

mysite/setting.py

# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/5.0/howto/static-files/

STATIC_URL = '/static/' # ←ここのURL
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'static'),
]

と

.
├── EmoRecord
│   ├── EmoRecord
│   │   ├── __init__.py
│   │   ├── admin.py
│   │   ├── apps.py
│   │   ├── forms.py
│   │   ├── migrations
│   │   ├── models.py
│   │   ├── static # ←ここのPath

さらに、

アプリごとの静的ファイル格納ディレクトリ
admin用の静的ファイル格納ディレクトリ
faviconファイル

という順にディレクトリを並べて配置しないとDjangoアプリ側で静的ファイルの存在を認識してくれなくなる（検索してくれない？）ようなので注意が必要です。

この設定を行うことで、無事静的ファイルが読み込まれ、完全なwebアプリをデプロイすることができます！
お疲れ様でした！

まとめ

というわけで今回は、Djangoで作成したアプリをPythonAnywhereでデプロイする時のコツを備忘録的にまとめてみました！
pythonでwebアプリを作成する際、プロトタイプを早めに作りたい時にとても便利ですね

筆者はwebアプリど素人なので、「こんな楽な方法があるよ！」を知ってる方がおられましたらぜひコメントお願いします！

最後に

本日も乱文でありましたが、ご覧いただきありがとうございました！
これからも組み込みやIoTに関する記事を投稿していく予定ですので、よろしくお願いいたします。

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up