Django | リューブログ

この記事は紹介編の続きの記事であり、DockerでPythonのWebフレームワークであるDjangoの開発環境構築を分かりやすく説明しています。Djangoを学んでみたい方、Pythonで何か作ってみたいと思っている方は読んでみてください。

アプリケーションを作成する
settings.pyを変更する
モデルを変更する
views.pyを確認用に変更する
URL関連の設定を行う
アプリにアクセスする
base.htmlを作成する
一覧表示テンプレートを作成する
データを追加できるようにする
まとめ

アプリケーションを作成する

countmemoアプリケーションを作成する

まず、manage.pyと同じディレクトリ上で以下のコマンドを実行し、countmemoアプリケーションを作成しましょう。

$ python3 manage.py startapp countmemo

このコードはDockerを利用している場合、以下のようなコードになります。

$ docker-compose run web ./manage.py startapp countmemo

上のコードを実行すると、countmemoディレクトリが作成され、その中にmodels.pyやviews.pyが入っているはずです。以下はPaizaCloudのスクリーンショットなので、表示形式は少し違うかもしれませんが、このようなファイル構成になっていれば問題ありません。exampleはプロジェクト名です。

settings.pyを変更する

その後、settings.pyに新しいアプリを作成したことを教えてあげましょう。settings.py内のINSTALLED_APPSに以下のように’countmemo.apps.CountmemoConfig’を記述します。

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'countmemo.apps.CountmemoConfig',
]

モデルを変更する

models.pyを変更する

次に、countmemoフォルダ内のmodels.pyを書き換えていきます。このmodels.pyを元にDjangoがデータベースを操作してくれるので、非常に大事なファイルです。今回は以下のように記述していきます。

from django.db import models
from django.utils import timezone

# Create your models here.
class MemoModel(models.Model):
    memo_text = models.CharField(max_length=200)
    up_date = models.DateTimeField(default=timezone.now)
    length = models.IntegerField(default=0)

    def __str__(self):
        return self.memo_text

マイグレーションを行う

models.pyに追記したらマイグレーションを実行しましょう。こうすることでDBに変更を加えます。models.pyを変更した場合は必ず行っておけば間違いありません。

manage.pyと同階層で以下のコマンドを実行します。

$ python3 manage.py make migrations
$ python3 manage.py migrate

Dockerの場合は、以下のようなコマンドになります。

$ docker-compose run web ./manage.py make migrations
$ docker-compose run web ./manage.py migrate

views.pyを確認用に変更する

countmemoフォルダ内のviews.pyを以下のように変更しましょう。

from django.shortcuts import render
from django.http import HttpResponse


def index(request):
    return HttpResponse("Hello, world!!!!!")

views.pyは簡単に言えばアプリの処理に関する役割を担います。今回は確認のために、Hello, world!!!!!と表示するように記述しています。

URL関連の設定を行う

countmemoアプリ内にurls.pyを作成する

views.pyを変更したら、次はurls.pyを変更してアクセスできるようにしましょう。まず、countmemoフォルダ内にurls.pyというファイルを作成し、以下のように記述します。

また、app_nameを記述することで、アプリが大量になったときにviews.pyやテンプレートファイルからアクセスしやすくなります。記述しておきましょう。

from django.urls import path

from . import views

app_name = 'countmemo'
urlpatterns = [
    path('', views.index, name='index'),
]

プロジェクト内のurls.pyを変更する

僕の場合は、exampleというプロジェクト名なので、exampleフォルダの中のurls.pyを変更していきます。こうすることで、countmemoアプリ内のurls.pyを読み込むようになります。

from django.contrib import admin
from django.urls import path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include('countmemo.urls')),
]

アプリにアクセスする

runserverコマンドを実行しましょう。

Dockerの場合は以下の、以前の記事で説明したURLに、それ以外の環境を使っている場合は環境構築時にDjangoのロケットが表示されていたURLにアクセスしてみてください。

トリミングしているため分かりづらいですが、上記のようにHello, world!!!!!と表示されていれば成功です。次のステップへと進みましょう。

base.htmlを作成する

次に、base.htmlを作成します。まず、countmemoフォルダの中にtemplatesフォルダを作成し、さらにそのtemplatesフォルダの中にcountmemoフォルダを作成しましょう。

そして、countmemoフォルダの中にbase.htmlを作成します。

現在、countmemo > templates > countmemo > base.htmlのようになっているはずです。そうであればbase.htmlに以下のように追記していきます。今回はbootstrap4を使うので、そちらもbase.htmlで読み込んでいきます。



    
        {% block title %}{% endblock %}
        
        
        

        
        
    
    
        {% block content %}
        {% endblock %}

        
        
        
        {% block extrajs %}
        {% endblock %}

base.htmlは他のhtmlファイルのひな型のようなものです。用いることで大幅にコードを減らすことができます。

一覧表示テンプレートを作成する

countmemoフォルダ内のviews.pyを以下のように変更します。generic.ListViewはデータ一覧を表示したい時に使うと便利です。テンプレートファイルには、object_listという名前でデータが渡されます。

from django.shortcuts import render
from django.views import generic

from .models import MemoModel

class MemoListView(generic.ListView):
    model = MemoModel
　　template_name = 'countmemo/memolist.html'

views.pyを変更したので、同じくcountmemoフォルダ内のurls.pyを以下のように変更します。classベースのviewを使った場合は、以下のようにas_view()をつけるようにしましょう。

from django.urls import path

from . import views

app_name = 'countmemo'
urlpatterns = [
    path('', views.MemoListView.as_view(), name='index'),
]

MemoListViewのためのmemolist.htmlを、templateフォルダ内のcountmemoフォルダ内に作成します。object_listで渡されたデータをfor文を用いて順に取り出し、テーブルの形にまとめています。

{% extends 'countmemo/base.html' %}

{% block title %} memolist {% endblock %}

{% block content %}
    
            {% for data in object_list %}
                
            {% endfor %}
        
        
            
                #
                テキスト
                文字長
                作成日
                
        
        
                    {{ data.id }}
                    {{ data.memo_text }}
                    {{ data.length }}
                    {{ data.up_date }}
                
    
{% endblock %}

#	テキスト	文字長	作成日
{{ data.id }}	{{ data.memo_text }}	{{ data.length }}	{{ data.up_date }}

ここまで完了したら、以下のコマンドでサーバーを動かしましょう。

$ python3 manage.py runserver

Dockerの場合は次のようなコマンドになります。ただ、Dockerの場合はdocker-compose up -dで既にrunserverを実行していると思うので、必要ないかもしれません。

$ docker-compose run web ./manage.py runserver

先ほどのURLにアクセスし、以下のようになっていれば成功です。

データを追加できるようにする

まず、views.pyに次のように記述します。

from django.shortcuts import render, redirect
from django.views import generic

from .models import MemoModel

class MemoListView(generic.ListView):
    model = MemoModel
    template_name = 'countmemo/memolist.html'
    

class CreateMemo(generic.CreateView):
    model = MemoModel
    fields = ['memo_text',]
    template_name = 'countmemo/memoadd.html'
    
    def form_valid(self, form):
        memo = form.save(commit=False)
        memo.length = len(memo.memo_text)
        memo.save()
        return redirect('countmemo:index')

変更点はCreateMemo以下です。この場合、models.pyで指定したmemo_textのみを入力し、lengthに入力された値の文字列長を格納するようにしています。

form_validは入力された文字列が要件を満たすときに呼び出されます。

次に、アプリの方のurls.pyを以下のように変更します。

from django.urls import path

from . import views

app_name = 'countmemo'
urlpatterns = [
    path('', views.MemoListView.as_view(), name='index'),
    path('add/', views.CreateMemo.as_view(), name='add'),
]

こちらも、変更点はview.CreateMemo.as_view()の部分だけです。

以前作成したmemolist.htmlにデータ追加ページに遷移するためのボタンを設置します。追記する場所はどこでもいいです。僕はテーブルの下のところに設置しました。

追加

その後、memoadd.htmlをmemolist.htmlやbase.htmlと同じフォルダに作成し、以下のように記述します。

{% extends 'countmemo/base.html' %}

{% block title %} memoadd {% endblock %}

{% block content %}
    
    {% csrf_token %}

    {{ form }}
    
    
{% endblock %}

bootstrapを適用させるにはformの内容をひとつづつ記述し、classを追加するか、javascriptやforms.py等で自動的に追加するかなどの作業が必要なのですが、今回は省きます。また、それらの記事も書くかもしれません。

ここまで終わったら、runserverコマンドを実行してWebアプリを動かしてみましょう。先ほどの画面に追加ボタンが現れているはずです。そのボタンをクリックしてください。以下の写真のようになっていれば成功です。

上手く動いていたら適当に入力してみてください。

このように、うまくカウントできていれば成功です。

まとめ

どうでしたか？Djangoを使えば、慣れてしまえば簡単なアプリをこのように30分程度で作れてしまいます。もちろん、今回のアプリはデザインも機能も優れているとは言い難いですが、Djangoのすごさを少しでも分かってもらえたのではないでしょうか。

もし、「ここが分からない」「分かりづらい」などありましたら、Twitter(@Ryu_programs)までよろしくお願いします。

また、今回利用したPythonの学習方法などもブログに書いています。よろしければ読んでみてください。

Django学習　～環境構築編～

リューさん — Tue, 07 Apr 2020 08:55:07 +0000

こんにちは。はじめまして。リューさん(@ryu_programs)です。この記事では以下のような人に向けて、Dockerを利用したDjangoの開発環境構築について説明していきます。

Djangoの学習をしたいけど、どうすればいいのか分からない
Djangoの環境構築につまづいている
紹介編を見て、Djangoを学習しようと思った

また、Djangoの紹介記事やPythonの勉強方法も書いています。もしまだ読んでいない方がいれば、読んでみてください。

Django学習 ~Django紹介編~

また、続編であるWebアプリ作成編も公開しました。良ければ読んでみてください。リンクは最後の方にも載せておきます。

Windows環境にDocker Toolboxをインストールする - Qiita

なぜDockerを選んだか
最初にすべきこと
Djangoの環境構築
おわりに

なぜDockerを選んだか

まず、Pythonという言語はモジュールをimportすることによって、機械学習やWebクローリング、Django開発など様々なことを行うことができます。また、所謂本家PythonであるPython3だけではなく、科学計算に強いAnacondaや、もしかするとやむにやまれぬ事情があってPython2をいまだに使われている人もいるかもしれません。

こう聞くとPythonを使ってそのまま開発していたら、ライブラリの数や環境がめちゃくちゃなことになると思いませんか？そこで登場するのが仮想マシンやDockerです。仮想マシンとDockerも仕組みが違うのですが、今回は単に僕の好きなツールであり、軽量かつ高速であるDockerを採用しました。

最初にすべきこと

まず、こちらの公式ドキュメント(https://docs.docker.com/toolbox/toolbox_install_windows/)を参考にしながら、Docker Toolboxをインストールしましょう。ちなみに、僕はWindows10 homeだったのでDocker Toolboxをインストールしたのですが、Macの場合はDocker for Macであったり、Windows10 ProであればDocker for Windowsがあるので、ご使用のPCによって変えましょう。

また、Docker Toolboxの場合はVirtualBoxを一度アンインストールしてからインストールすると良いかもしれません。Docker Toolboxをインストールすると勝手にVirtualBoxまで付いてくるので、既に存在しているとエラーが出る可能性があります。僕がインストールした時にはそこでエラーが出て躓きました。

詳しいインストール方法を紹介している記事はすでにたくさんありますし、OSによってもインストール方法が違う可能性があるのでこの記事では省略します。Docker Toolboxのインストールの際、参考になった記事を紹介しておきます。

はじめに Docker、非常に便利ですね。Dockerを使用すればローカル環境を汚すことなく、様々なアプリケーションを実行できたりしてしまいます。Dockerに関する記事はネット上に豊富にありますが、いかんせん界隈の技術の進歩も早くすぐに情...

Djangoの環境構築

Dockerのインストールが終わると、次にDjangoの開発環境を整えていきます。この際、もしPycharmやVScodeなどのエディタをインストールしていない場合、しておくことをお勧めします。ちなみに僕はPythonを使うならPycharmが好きです。

PyCharm - 唯一の必携 Python IDE

ウェブ、データ、および AI/ML のプロ開発者向けに構築。 AI による IDE エクスペリエンスで強化されています。

1.作業ディレクトリの作成

Djangoプロジェクトが格納されるディレクトリを適当な場所に作成します。ただし、この時は作成するだけでそのディレクトリは空にしておきましょう。そして、Docker Toolboxを起動し、cdコマンドでそのディレクトリに移動します。

この後いくつかのファイルを作成しますが、僕はviコマンドを利用して作成しました。

2.Dockerfileの作成

次に、Dockerfileをそのディレクトリの中に作成します。Dockerfileは、そこに記述された内容に基づいてDockerイメージを作成します。Dockerfileについて、より詳しく知りたい方は以下の記事を読んでみてください。

Docker入門（第四回）～Dockerfileについて～ | さくらのナレッジ

こんにちは、Acroquest Technologyの横山です。 4/19(木)にKubernetesやDockerを中心としたコンテナ活用の現状をひとまとめにした開発者のためのイベントである「Japan Contain

Dockefileには以下のように記述します。

From python:3.7
ENV PYTHONBUFFERED 1
RUN mkdir /code
WORKDIR /code
COPY requirements.txt ./
RUN pip install --upgrade pip
RUN pip install -r requirements.txt
ADD . /code

例えば、

RUN mkdir /code

というコードは、codeディレクトリをmkdirコマンドで作成しています。このようにRUNやADDなどのコマンドと、それに対応する命令を記述しています。

3.requirements.txtの作成

次に、requirements.txtを記述していきます。requirements.txtは、pipを使って指定のパッケージを指定のバージョンでインストールできる設定ファイルです。先ほど作成したディレクトリに、Dockerfileと同様にrequirement.txtを作成して以下のように記述します。

Django
psycopg2

これは、Djangoとpsycopg2をインストールするという意味です。psycopg2の後に改行しないように気をつけてください。また、これは注意点なのですが、このrequirement.txtやdockerfileを更新した場合には、以下のように実行しなければ反映されません。

$ docker-compose up --build -d

4.docker-compose.ymlの作成

こちらも先ほどと同じく、作成したディレクトリにdocker-compose.ymlというファイルを作成して記述していきます。このファイルを作成することで、管理が非常に楽になります。内容は以下の通りです。8000ポートでアクセスできるようにしています。


version: '3'

services:
  db:
    image: postgres
    volumes:
      - poll_db_data:/var/lib/postgresql/data:Z
    ports:
      - "5432"
    environment:
      - POSTGRES_DB=postgres
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=mypassword
  web:
    build: .
    command: python manage.py runserver 0.0.0.0:8000
    volumes:
      - .:/code
    ports:
      - "8000:8000"
    depends_on:
      - db

volumes:
  poll_db_data:
    external: true

Dockerはコンテナを削除してしまうと、データベースの内容もすべて消えてしまうので、”poll_db_data”というvolumeを作成し、このようにZオプションをつけたり、external: trueを指定したりしています。

5.プロジェクトの作成

$ docker-compose run web django-admin.py startproject [プロジェクト名] .

このようなコマンドを実行することで、manage.pyの他プロジェクトディレクトリが作成されます。プロジェクト名は基本何でも良いです。また、docker-composeコマンドはdocker-compose.ymlが存在するディレクトリの中で実行してください。

次に、作成されたプロジェクトディレクトリの中のsettings.pyを開き、DATABASE=・・・のところを以下のように記述します。USERやPASSWORDは適当です。好きなものを使ってください。

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'postgres',
        'USER': 'postgres',
        'PASSWORD': 'mypassword',
        'HOST': 'db',
        'PORT': 5432,
    }
}

また、同じくsetting.pyのALLOWED_HOSTの部分を以下のように変更します。

ALLOWED_HOSTS = ["*"]

その後、以下のコマンドでDBのマイグレーションを行います。

$ docker-compose run web ./manage.py makemigrations
$ docker-compose run web ./manage.py migrate

さらに、スーパーユーザーも作成してしまいます。以下のコマンドを実行すると、ユーザ名やメールアドレス、パスワード等の入力を求められると思うので、入力してください。Djangoの管理ページにアクセスするために必要です。

$ docker-compose run web ./manage.py createsuperuser

6.コンテナの作成・起動

$ docker-compose up -d

このコマンドを実行してコンテナを作成・起動しましょう。-dオプションをつけることで、コンテナ起動後もコマンドを実行できます。

そして、次のコマンドでdefaultマシンに割り振られたipアドレスを取得します。僕の場合はdefaultマシンをそのまま使っていますが、別のマシンを使っている方はそのマシンについて調べてください。何もしていなければdefaultマシンを使っているはずです。

$ docker-machine ip default

7.アクセス

chrome等で、http://[6で調べたIPアドレス]:8000でアクセスしてみてください。(例：http://0.0.0.0:8000)この8000はdocker-compose.ymlで指定した値です。

以下のような画面になれば正しく環境構築ができています。正確には、右上のDjangoは3.0などになっているはずです。

おわりに

以上で環境構築編は終わりです。開発編に続きます。Pythonの勉強方法やDjangoの紹介、基本情報技術者試験の勉強方法なども分かりやすく書いているので、良ければ読んでみてください。

基本情報技術者試験はエンジニアとしての基礎的な知識が問われる試験で、勉強すべき範囲が非常に広く、100時間程度の勉強が必要と言われています。その基本情報技術者試験をこれから受けようと思っている人に向けて、僕が勉強してきたことを紹介します。

Django学習 ~Django紹介編~

基本情報技術者試験に合格できた勉強方法

開発編も公開しました！

また、よろしければ僕のTwitter(@ryu_programs)のフォロー等もお願いします。

Django学習 ~Django紹介編~

リューさん — Mon, 06 Apr 2020 06:10:41 +0000

こんにちは、はじめまして。リューさん(@Ryu_programs)です。この記事ではPythonのWebアプリケーションフレームワークであるDjangoについて、以下のような人のために紹介していきます。

Pythonを学習しているけど、Pythonで何ができるのか分からない
Pythonを使って就活にも役立つ成果物を作ってみたい
プログラミングに興味あるけど、何から始めればいいのか分からない

なお、この記事は「環境構築編」や「簡単なアプリケーション作成編」などに続いていく予定です。ぜひこの記事を読み、Djangoについて軽く理解しておいてください。

また、Pythonの勉強方法については以下の記事で紹介しています。Pythonは基本的なことに関しては覚えやすく、コードも書きやすいので、「プログラミングを学習したい！」と思っている人にはお勧めの言語です。

Webフレームワークとは
Djangoの特徴
おわりに

Webフレームワークとは

先ほども書きましたが、DjangoとはPythonのWebフレームワークです。そもそもWebフレームワークとは、便利な機能が用意されており、利用することでWebアプリケーションを簡単に短期間で作成できるようにするといったものです。

WebフレームワークにはDjangoのほか、多くの種類があります。この記事ではその中でも有名でよく使われているWebフレームワークを簡単に紹介します。

1.Laravel

LaravelはPHPという言語のフレームワークです。そもそも、PHPという言語自体がWeb開発に多く使われていたこともあり、LaravelやPHPのもう一つのフレームワークであるCakePHPは非常に人気のWebフレームワークです。

ちなみに、PHPがWeb開発に多く使われると書きましたが、それはPHPが動的にWebページを生成できる、サーバサイドのスクリプト言語であるからです。PHPはWordPressなどにも使われていますね。

2.Ruby on rails

Ruby on railsはRubyという言語のフレームワークです。僕が大学1年生の夏に初めて学習した言語がRubyでした。プログラミングの基礎知識など全くなかった僕が、1ヵ月でPaizaのスキルチェックでBランクを獲得できたのは、ひとえにRubyという言語の書きやすさであったり、分かりやすさのおかげだと思います。Ruby on railsもその特徴を受け継いでいます。

また、Rubyという言語は日本人のまつもとゆきひろさんが開発された言語であり、その影響なのか日本語の説明が多いことも特徴です。分からないことでもググったら大体日本語での解決法がヒットする、というのは安心できますよね。

Djangoの特徴

Djangoの特徴は以下の3点です。もちろんこれ以外の強みも多くあると思いますが、その中でも特に僕が便利だと感じた点を紹介しています。

データベースに強い
同じPythonのWebフレームワークであるFlaskよりも大規模開発に向いている
機械学習と組み合わせられる

1.データベースに強い

まず、1つめのデータベースに強いというのは、DjangoはOracle、SQLite、MySQL、PostgreSQLなどのデータベースに対応しており、なおかつ簡単にデータベースを操作できるからです。

Djangoドキュメントのチュートリアルのような簡単なWebアプリの場合、ほとんどデータベースの知識は必要ありません。(あった方が良いのはもちろんですが。）つまり、Pythonの知識さえ最低限あれば、簡単なWebアプリが作れてしまうということです。

2.大規模開発に向いている

Djangoはログイン機能やセキュリティ対策など必要な機能が全てそろっており、基本的にはDjango単体でWebアプリを開発することができます。このようなフレームワークをフルスタック・フレームワークと呼び、DjangoのほかRuby on railsなどもこのフルスタック・フレームワークです。

一方でFlaskなどはマイクロフレームワークと呼ばれており、必要最低限の機能しか備えていません。そのため、足りない機能は拡張などで補うことになります。ただ、このようなマイクロフレームワークは小規模の開発をする際や初心者には、機能が少ないため分かりやすいというメリットもあります。

3.機械学習と組み合わせられる

DjangoでWebアプリケーションを開発する際にはPythonという言語を使いますが、そのPythonは機械学習に強い言語です。また、Webクローリング等もPythonを使うことで簡単に行うことができます。

そのため、機械学習やWebクローリングで得られたデータをDjangoを使って表示するWebアプリケーションを、Pythonという言語だけで実装することができるのはDjangoの強みです。

Djangoを利用しているサービス

例えば、InstagramやMozillaなどがDjangoを利用して開発された有名なサービスです。1度は使ったことがある人も多いのではないでしょうか。Pythonを使って、あのような素晴らしいサービスを作成することができます。

おわりに

この記事ではDjangoやWebフレームワークの紹介をしました。参考になれば幸いです。また、もしよろしければTwitter(@ryu_programs)のフォロー等もお願いします。この記事の次はDockerを利用したDjango開発環境構築の記事です。

公開しましたので、読んでみてください。