Django项目的开发准备工作
前提条件
项目名称：hogehoge
Django3.2
Python3.9
使用PyCharm创建项目
选择[新项目]
只使用纯Python创建项目
※使用Django创建项目会导致基本目录名和配置目录名相同。这次我们希望将基本目录名设为hogehoge，配置目录名设为config，因此选择纯Python来创建。
打开偏好设置（⌘，）
创建requirements.txt
在PyCharm的选项卡中打开终端，执行以下命令。
(venv) user hogehoge % pip freeze > requirements.txt
修改配置文件的结构
(venv) user hogehoge % django-admin startproject config .
(venv) user hogehoge % mkdir config/settings
(venv) user hogehoge % mv config/settings.py config/settings/_base.py
(venv) user hogehoge % touch config/settings/local.py config/settings/production.py
更新.env文件
在定义变量时，需要注意不要有空格和单引号。
(venv) user hogehoge % vim .env
# Secret Key
SECRET_KEY=django-insecure-hjgklfd.....（settings/_base.pyのSECRET_KEY）
# Allowed Hosts
ALLOWED_HOSTS=*
# MySQL settings
DATABASE_URL=mysql://[username]:[password]@127.0.0.1:3306/hogehoge?charset=utf8mb4&sql_mode=TRADITIONAL,NO_AUTO_VALUE_ON_ZERO
更新配置文件
可以依据自己的喜好来处理细节问题。
-
- settings/_base.pyの変更点
environをインポート
BASE_DIRの取得方法を変更
PROJECT_NAMEを追加
SECRET_KEYを.envから取得するように変更
DEBUGを削除
ALLOWED_HOSTSを.envから取得するように変更
TEMPLATESの’DIRS’にディレクトリを追加
DATABASESを.envから取得するように変更
LANGUAGE_CODEを’ja’に変更
TIME_ZONEを’Asia/Tokyo’に変更
STATICFILES_DIRSを追加
import os
import environ
###############
# Build paths #
###############
BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
PROJECT_NAME = os.path.basename(BASE_DIR)
# Read .env if exists
env = environ.Env()
env.read_env(os.path.join(BASE_DIR, '.env'))
#####################
# Security settings #
#####################
SECRET_KEY = env('SECRET_KEY')
ALLOWED_HOSTS = env.list('ALLOWED_HOSTS')
# Application definition
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
]
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
ROOT_URLCONF = 'config.urls'
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [
os.path.join(BASE_DIR, 'templates'),
],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]
WSGI_APPLICATION = 'config.wsgi.application'
# Password validation
# https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
AUTH_PASSWORD_VALIDATORS = [
{
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
},
]
############
# Database #
############
DATABASES = {
'default': env.db()
}
# Internationalization
# https://docs.djangoproject.com/en/3.2/topics/i18n/
LANGUAGE_CODE = 'ja'
TIME_ZONE = 'Asia/Tokyo'
USE_I18N = True
USE_L10N = True
USE_TZ = True
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/3.2/howto/static-files/
STATIC_URL = '/static/'
STATICFILES_DIRS = [os.path.join(BASE_DIR, 'static')]
# Default primary key field type
# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
from ._base import *
############
# Debug #
############
DEBUG = True
############
# Static #
############
STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles')
from ._base import *
############
# Debug #
############
DEBUG = False
############
# Static #
############
STATIC_ROOT = '/var/www/{}/static'.format(PROJECT_NAME)
###########
# Logging #
###########
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'production': {
'format': '%(asctime)s [%(levelname)s] %(process)d %(thread)d '
'%(pathname)s:%(lineno)d %(message)s'
},
},
'handlers': {
'file': {
'level': 'INFO',
'class': 'logging.handlers.TimedRotatingFileHandler',
'when': 'D',
'interval': 1,
'backupCount': 30,
'filename': '/var/log/{}/app.log'.format(PROJECT_NAME),
'formatter': 'production',
},
},
'loggers': {
'': {
'handlers': ['file'],
'level': 'INFO',
'propagate': False,
},
'django': {
'handlers': ['file'],
'level': 'INFO',
'propagate': False,
},
},
}
设定环境变量(DJANGO_SETTINGS_MODULE)。
由于我的配置文件的结构始终保持不变，我总是使用环境变量。
- manage.py, wsgi.py, asgi.pyからデフォルト設定をしている行を削除
- os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
- os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
- os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
- 環境変数を追加
如果您正在使用Bash等命令解释器，请根据各自的环境进行相应调整。
(venv) user hogehoge % vim ~/.zshrc
+ # Django Setting
+ export DJANGO_SETTINGS_MODULE=config.settings.local
由于添加了设置，请重新加载。
(venv) user hogehoge % source ~/.zshrc
在本地的MySQL上创建一个数据库。
假设已经完成了MySQL的安装。
请使用.env文件中的DATABASE_URL中所记录的username和databasename进行创建。
(venv) user hogehoge % $ sudo mysql.server start
(venv) user hogehoge % $ mysql -u [username] -p
mysql> create database hogehoge;
mysql> exit
创建.gitignore文件
(venv) user hogehoge % touch .gitignore
可以使用gitignore.io来创建内容
使用词汇例如[PyCharm][Python][Django]等即可
https://www.toptal.com/developers/gitignore
将已创建的文本粘贴到.gitignore文件中。
创建一个简单的网页
追加网址
from django.contrib import admin
from django.urls import path
from django.views.generic import TemplateView
urlpatterns = [
path('admin/', admin.site.urls),
path('', TemplateView.as_view(template_name='home.html'), name='home'),
]
创建模板和静态文件
(venv) user hogehoge % mkdir templates
(venv) user hogehoge % touch templates/_base.html
(venv) user hogehoge % touch templates/home.html
(venv) user hogehoge % mkdir -p static/css
(venv) user hogehoge % mkdir -p static/js
(venv) user hogehoge % touch static/css/home.css
(venv) user hogehoge % touch static/js/home.js
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="utf-8">
<title>{% block head_title %}{% endblock %}</title>
{% block extra_css %}{% endblock %}
{% block extra_js %}{% endblock %}
</head>
<body>
{% block content %}{% endblock %}
</body>
</html>
{% extends "_base.html" %}
{% load static %}
{% block head_title %}ホーム | hogehoge{% endblock %}
{% block extra_css %}
<link rel="stylesheet" href="{% static 'css/home.css' %}">
{% endblock %}
{% block extra_js %}
<script src="{% static 'js/home.js' %}"></script>
{% endblock %}
{% block content %}
<h1 onclick="h1Click()">Hello World!</h1>
{% endblock %}
h1 {
color: blue;
}
function h1Click(){
alert('h1 Click');
}
尝试启动服务器
(venv) user hogehoge % python manage.py migrate
(venv) user hogehoge % python manage.py runserver
如果能够成功启动服务器并且确保CSS和JS有效运行，就可以将其推送到GitHub。
将代码推送到GitHub。
在执行命令之前，请在GitHub上创建一个名为”hogehoge”的空项目。
(venv) user hogehoge % git init
(venv) user hogehoge % git add .
(venv) user hogehoge % git commit -m "first commit"
(venv) user hogehoge % git branch -M main
(venv) user hogehoge % git remote add origin git@github.com:xxx/hogehoge.git
(venv) user hogehoge % git push -u origin main
