[PYTHON] Django Project Baseline

• [Directory structure](https://qiita.com/suehiro24/items/a295cdff86d1bdcba053#%E3%83%87%E3%82%A3%E3%83%AC%E3%82%AF%E3%83%88 % E3% 83% AA% E6% A7% 8B% E6% 88% 90)

Create directory & build virtual environment in Terminal

Project root directory

terminal@Appropriate directory

mkdir {project-name}
cd {project-name}

• The root-dir described below refers to the {project-name} directory created here.

Virtual environment

Create

terminal@root-dir

python -m venv {env-name}

Start-up

terminal(ps)

{env-name}\Scripts\activate

or

terminal(bash)

source {env-name}/bin/activate

Once you've done this Work by opening the project file and terminal in an editor

Create Django projects and apps

Create Django Project

terminal

python -m pip install --upgrade pip
python -m pip install Django
django-admin.exe startproject {project-name} .

• The {project-dir} described below refers to the directory created here.

Application creation

terminal

python manage.py startapp {app-name} .

• The {app-dir} described below refers to the directory created here.

from here, The main part of the baseline including environment variable management by .env and isolation by environment of setting.py.

Main story

Added static and template directories directly under the Application directory

• [Directory structure](https://qiita.com/suehiro24/items/a295cdff86d1bdcba053#%E3%83%87%E3%82%A3%E3%83%AC%E3%82%AF%E3%83%88 Created with reference to {app-dir} of% E3% 83% AA% E6% A7% 8B% E6% 88% 90).
• In addition, create a {app-name} directory directly under each directory. (Countermeasures when it overlaps with the file name of another app)
• After that, create an appropriate template file or static file.

Create urls.py directly under Application directory

Create

{app-dir}/urls.py

from django.urls import path, include
from django.conf.urls import url

from . import views


app_name = '{app-name}'

urlpatterns = [
    path('', views.index, name='index'),  #index handler is views.Suppose it is defined in py
]

The routing managed by app-dir is called by project-dir.

{project-dir}/urls.py

from django.conf.urls.static import static
from django.conf import settings
from django.contrib import admin
from django.urls import path, include
from django.views.generic import TemplateView


urlpatterns = [
    path('admin/', admin.site.urls),
    path("", include("fit.urls")),
    path('sw.js', (TemplateView.as_view(template_name="book_manager/sw.js", content_type='application/javascript', )), name='sw.js'),
]

• Minimal routing completed.

Handler definition in views.py

views.py

from django.shortcuts import render


def index(request):
    return render(request, "fit/index.html", {
        "key": "value",
    })

• Minimum handler creation completed.
• Prepare an appropriate template file (here, ʻindex.html) directly under ʻapp-dir / template in advance.

Settings in Settings.py using .env

install django-dotenv

terminal

python -m pip install django-dotenv

.env creation

root/.env

SECRET_KEY = {Copyed secret key}
DJANGO_SETTINGS_MODULE = fitmod.settings.local  #Local(settings will be separated later)

Modification of settings.py (only the changed / added part is described)

settings.py

from dotenv import load_dotenv

# loading env-vars
load_dotenv('.env')

SECRET_KEY = os.getenv("SECRET_KEY")

# ~Abbreviation~

INSTALLED_APPS = [
    ...
    '{app-name}', 
]

# ~Abbreviation~

LANGUAGE_CODE = "ja"

TIME_ZONE = "Asia/Tokyo"

• Only changes are listed

Isolation of settings.py

• Copy settings.py to local.py and production.py directly under root / project-dir / setting.
• Set BASE_DIR, DEBUG, ALLOWED_HOSTS, DB surroundings, etc. according to the local and production environments.

Use .env to rewrite settings.py loaded by wsgi.py and manage.py

wsgi

root/{project-dir}/wsgi.py

import os

from django.core.wsgi import get_wsgi_application
from dotenv import load_dotenv


load_dotenv('.env')
DJANGO_SETTINGS_MODULE = os.getenv("DJANGO_SETTINGS_MODULE")

os.environ.setdefault('DJANGO_SETTINGS_MODULE', DJANGO_SETTINGS_MODULE)

application = get_wsgi_application()

• See here for wsgi.py when deploying on Heroku
• Use Cling

wsgi

root/manage.py

#!/usr/bin/env python
"""Django's command-line utility for administrative tasks."""
import os
import sys

from dotenv import load_dotenv


load_dotenv('.env')
DJANGO_SETTINGS_MODULE = os.getenv("DJANGO_SETTINGS_MODULE")


def main():
    os.environ.setdefault('DJANGO_SETTINGS_MODULE', DJANGO_SETTINGS_MODULE)
    try:
        from django.core.management import execute_from_command_line
    except ImportError as exc:
        raise ImportError(
            "Couldn't import Django. Are you sure it's installed and "
            "available on your PYTHONPATH environment variable? Did you "
            "forget to activate a virtual environment?"
        ) from exc
    execute_from_command_line(sys.argv)


if __name__ == '__main__':
    main()

The end of the main part of the baseline.

migration

terminal

python manage.py makemigrations
python manage.py migrate

createsuperuser

terminal

python manage.py createsuperuser

Server startup

terminal

python manage.py runserver

Directory structure

{root-dir}/
     │
     ├ {project-name(project-dir)}
     │     ├ settings    #add to
     │ 　  │     ├ init.py
     │ 　  │     ├ local.py
     │ 　  │     └ production.py
     │ 　  ├ init.py
     │　   ├ urls.py
     │　   ├ asgi.py
     │　   ├ wsgi.py
     │     └ db.sqlite3  #When using SQLite
     │
     ├ {app-name(app-dir)}
     │     ├ migrations
     │     ├ template    #add to
     │     │     └ {app-name}
     │     │  　　　　 └ ...
     │     ├ static      #add to
     │     │　   └ {app-name}
     │     │     　　　└ ...
     │ 　  ├ init.py
     │     ├ admin.py
     │     ├ apps.py
     │     ├ model.py
     │     ├ test.py
     │     ├ urls.py     #add to
     │     └ views.py
     │
     ├ venv/
     │   └ ...
     │
     ├ manage.py
     │
     ├ .env              #add to
     ├ .gitignore        #add to
     ├ requirements.txt  #add to(When using heroku)
     ├ Procfile          #add to(When using heroku)
     ├ runtime.txt       #add to(When using heroku)
     └ db.sqlite3  #When using SQLite

.gitignore

root/.gitignore

*.pyc
*~
__pycache__
db.sqlite3
/static
.env
venv