無料版PyCharmCEのFlask開発環境をwindows10で構築した手順

2020年6月13日

いままで、WEB開発のサーバサイドは、Kotlinで開発して、herokuにデプロイを考えていましたが、herokuにデプロイすると動かない症状に悩まされていました。
この際、herokuをあきらめて、pythonで開発することに変更しました。

ここでは、PyCharmを使ってFlaskの開発環境を構築した手順を記載します。

きっかけ

Web サービスという名目でのアフィリエイトサイトを作っています。
公開するためには、どこかにデプロイしないといけないんですが、自分が使っている XserverでJavaは実行できない。

そこで、ネットでよく見かけるHerokuにデプロイして見る事にしたのですが、local環境では動作するのに、デプロイするとエラーになっていて動かないという状況で1週間ぐらい悩んでました。

悩み悩んでも解決できないので、この際、Kotlin + herokuでのサービス開発はあきらめて、もう一つの案で、pyhonでRESTを作り、JavaScriptで画面を作る方向で検討しようと思います。

そこで、まずは開発環境だろうという事で、PyCharmを使ってFlaskの開発環境を構築した手順を記載します。

自分のスキルなど

  • サーバーはエックスサーバーを使用
  • WEBサービス開発は初心者
  • pythonは実務で簡単なスクリプトを作った程度の初心者

やったこと要点

  • python3のインストール
  • PyCharmをインストール&プロジェクト作成
  • Flaskをインストール
  • 実行環境の作成

参考サイト

Python 3 のインストール

python公式サイトからPython 3 をインストールします。
https://www.python.org/downloads/ からダウンローダーを取得してインストールします。

インストール時に、Add Python 3.8 to PATH にチェックを入れます。

インストールするとコマンドプロンプトから実行できるようになります。

> python --version
Python 3.8.2

> where python
C:\Users\kimura\AppData\Local\Programs\Python\Python38-32\python.exe

PyCharm Community版のインストール

次にPyCharm CEをインストールします。

https://www.jetbrains.com/pycharm/download/#section=windows からCommunity版のインストーラーを使ってインストールします。

起動すると幾つか設定が開きます。

PyCharmプロジェクトを作成

プロジェクトを作成するには、PyCharm 起動後に「Create New Project」をクリックします。

プロジェクト作成の際に次の内容を入力します。

Location にプロジェクトを置くディレクトリを指定します。僕は基本的にworkディレクトリを作成して作業ごとにおいているので、「C:\work\vod」としています。

また、New environment usingを指定して、仮想環境を作成します。

PyCharmのプロジェクトが作成されました。

PyCharm CEからFlaskアプリを起動

PyCharmでは、FlaskのサポートはProfessional版でサポートされていて、PyCharm CEではサポートされていません。

しかし、調べてみると無料版のPyCharm CEでもFlaskアプリを開発できそうなので、やってみます。

terminalを開き、Flaskをインストール

ネットを調べると、プロジェクト作成からFlaskのプロジェクトが作れるのですが、PyCharm CEではFlaskを正式サポートしていないので、プロジェクト作成でFlaskを選べません。

そこで、pipを使って普通にFlaskをインストールします。

(venv) C:\work\vod>pip install Flask

File>Settings>Project>Python Interpreterで確認するとFlask、jinjaなど必要なライブラリがインストールされた状態になります。

最初に実行するファイルを作成

FlaskでHello Worldを表示するファイルを作成します。

app.pyのソースは以下です。

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello World!'

実行構成を作成

これでプロジェクトで Flask を使えるので、後は実行構成(Run/Debug Configuration)を整えます。

Run > Edit Configuraion… で実行構成(Run/Debug Configuration)の設定ダイアログを開き 以下のように設定します。

  1. Script Path を Module Name に変更
  2. コマンド名を flask を入力
  3. Parameters に run を入力
  4. Environment variables に最初に読ませるファイル名の定義 「FLASK_APP=app.py」

debugの設定「FLASK_DEBUG=1」を追加し、以下に変えました。 

PYTHONUNBUFFERED=1;FLASK_APP=app.py;FLASK_DEBUG=1
  1. Working Directoryに、ソースコードが置かれているパスを追加

以上でFlaskアプリが実行できるようになりました。

ブラウザで http://127.0.0.1:5000/ を開くと「Hello World!」と表示されます。