cookiecutter-django是github上有著(zhù)超過(guò)6000多顆星的第三方庫,可以快速生成比django-admin startproject命令生成的默認目錄更優(yōu)秀的目錄布局。今天我們就來(lái)看看cookiecutter-django生成的項目目錄結構的優(yōu)點(diǎn),講下為什么它勝出的原因。
我們先看下Django默認項目目錄,相信你一定并不陌生。
myproject├── myproject│ ├── __init__.py│ ├── settings.py│ ├── urls.py│ └── wsgi.py└── manage.py而利用cookiecutter-django生成的項目目錄結構如下所示。它把原myproject目錄下的項目設置文件比如settings.py, urls.py和wsgi.py都移到了一個(gè)專(zhuān)門(mén)的管理設置的config文件夾,這樣原myproject目錄變成用于存放各個(gè)app所屬代碼,邏輯變得更清晰。
除此以外settings.py文件變成了settings文件夾,分別用于存放開(kāi)發(fā)及生產(chǎn)環(huán)境下的配置文件。
├── settings│ ├── __init__.py│ ├── base.py│ ├── local.py│ └── production.py
cookiecutter-django借助于django-environ這個(gè)第三方庫區分不同環(huán)境,并把設置文件里的敏感信息放在環(huán)境變量里集中管理,而不是代碼中,這是非常聰明的做法。一來(lái)更安全,二來(lái)后續如果需要修改項目配置,只需要修改環(huán)境變量即可,不需要修改一行代碼。如下所示:
from .base import env
# GENERAL# ------------------------------------------------------------------------------# https://docs.djangoproject.com/en/dev/ref/settings/#secret-keySECRET_KEY = env('DJANGO_SECRET_KEY')# https://docs.djangoproject.com/en/dev/ref/settings/#allowed-hostsALLOWED_HOSTS = env.list('DJANGO_ALLOWED_HOSTS', default=['xxx.com'])除此以外,cookiecutter-django將設置文件里的INSTALLED APP分成了3類(lèi), Django自帶APP, 第三方APP和用戶(hù)自己開(kāi)發(fā)的APP,便于維護。
# APPS# ------------------------------------------------------------------------------DJANGO_APPS = ['django.contrib.auth','django.contrib.contenttypes','django.contrib.sessions','django.contrib.sites','django.contrib.messages','django.contrib.staticfiles','django.contrib.admin',]THIRD_PARTY_APPS = ['allauth','allauth.account','allauth.socialaccount','rest_framework','django_celery_beat',]LOCAL_APPS = ['myproject.users.apps.UsersConfig',# Your stuff: custom apps go here]# https://docs.djangoproject.com/en/dev/ref/settings/#installed-appsINSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS
另外依賴(lài)文件也由一個(gè)requirements.txt也變成了一個(gè)文件夾,分別存放基礎依賴(lài)文件base.txt,以及開(kāi)發(fā)和生產(chǎn)環(huán)境下分別使用的local.txt和production.txt。
每個(gè)requirements.txt也分成了python, django和DRF三類(lèi)。
#pythonpytz==2019.3 python-slugify==4.0.0 Pillow==6.2.1 redis==3.4.1 celery==4.3.0 oauthlib==3.1.0python3-openid==3.1.0requests==2.22.0requests-oauthlib==1.3.0six==1.13.0sqlparse==0.3.0urllib3==1.25.7# Django# ------------------------------------------------------------------------------django==3.0 # pyup: < 3.0 # https://www.djangoproject.com/django-allauth==0.41.0 # https://github.com/pennersr/django-allauthdjango-redis==4.11.0 # https://github.com/niwinz/django-redisdjango-filter==2.2.0django-celery-beat==1.6.0 # https://github.com/celery/django-celery-beat | Django backed periodic tasksdjango-crispy-forms==1.7.2 # https://github.com/django-crispy-forms/django-crispy-formsdjango-environ==0.4.5 # https://github.com/joke2k/django-environdjango-model-utils==3.2.0 # https://github.com/jazzband/django-model-utils
# Django REST Frameworkdjangorestframework==3.10.2 # https://github.com/encode/django-rest-frameworkcoreapi==2.3.3 # https://github.com/core-api/python-client小結
cookiecutter-django生成的項目模板布局有著(zhù)明顯的優(yōu)勢。哪怕你不使用這個(gè)第三方庫,你也可以學(xué)習它的優(yōu)點(diǎn),讓你的項目更專(zhuān)業(yè)。
聯(lián)系客服