CircleCI Django 示例项目教程

CircleCI Django 示例项目教程

circleci-demo-python-djangoExample Django application running on CircleCI项目地址:https://gitcode.com/gh_mirrors/ci/circleci-demo-python-django

1. 项目的目录结构及介绍

circleci-demo-python-django/
├── circleci/
│   └── config.yml
├── catalog/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── migrations/
│   ├── models.py
│   ├── tests.py
│   ├── urls.py
│   └── views.py
├── locallibrary/
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── templates/
│   └── registration/
├── .gitignore
├── LICENSE
├── Pipfile
├── Pipfile.lock
├── Procfile
├── README.md
├── manage.py
├── requirements.txt
└── runtime.txt

目录结构介绍

• circleci/: 包含 CircleCI 的配置文件 config.yml。
• catalog/: Django 应用目录，包含模型、视图、URL 配置等。
• locallibrary/: Django 项目目录，包含项目设置、URL 配置等。
• templates/: 包含 Django 模板文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• Pipfile 和 Pipfile.lock: 用于管理项目依赖。
• Procfile: 用于 Heroku 部署。
• README.md: 项目说明文档。
• manage.py: Django 管理脚本。
• requirements.txt: Python 依赖列表。
• runtime.txt: 指定 Python 运行时版本。

2. 项目的启动文件介绍

manage.py

manage.py 是 Django 项目的管理脚本，用于执行各种管理任务，如启动开发服务器、创建数据库迁移、运行测试等。

python manage.py runserver  # 启动开发服务器
python manage.py makemigrations  # 创建数据库迁移
python manage.py migrate  # 应用数据库迁移
python manage.py test  # 运行测试

wsgi.py

wsgi.py 是 Django 项目的 WSGI 应用程序入口点，用于生产环境部署。

import os
from django.core.wsgi import get_wsgi_application

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'locallibrary.settings')
application = get_wsgi_application()

3. 项目的配置文件介绍

settings.py

settings.py 是 Django 项目的主要配置文件，包含数据库配置、静态文件配置、中间件配置等。

# 部分配置示例
import os

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
SECRET_KEY = 'your-secret-key'
DEBUG = True
ALLOWED_HOSTS = []

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'catalog',
]

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',
]

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}

STATIC_URL = '/static/'

config.yml

config.yml 是 CircleCI 的配置文件，定义了 CI/CD 流程，包括构建、测试和部署步骤。

version: 2
jobs:
  build:
    docker:
      - image: circleci/python:3

circleci-demo-python-djangoExample Django application running on CircleCI项目地址:https://gitcode.com/gh_mirrors/ci/circleci-demo-python-django