Django Extra Settings 项目教程

Django Extra Settings 项目教程

django-extra-settings:gear: config and manage typed extra settings using just the django admin.项目地址:https://gitcode.com/gh_mirrors/dj/django-extra-settings

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

Django Extra Settings 项目的目录结构如下：

django-extra-settings/
├── django_extra_settings/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── fields.py
│   ├── forms.py
│   ├── models.py
│   ├── settings.py
│   ├── templatetags/
│   │   ├── __init__.py
│   │   ├── extra_settings.py
│   ├── tests/
│   │   ├── __init__.py
│   │   ├── settings.py
│   │   ├── test_admin.py
│   │   ├── test_fields.py
│   │   ├── test_models.py
│   │   ├── test_settings.py
│   │   ├── test_templatetags.py
│   ├── urls.py
│   └── views.py
├── manage.py
├── README.md
├── requirements.txt
├── setup.py
└── tox.ini

目录结构介绍

• django_extra_settings/: 项目的主要代码目录，包含了所有的 Python 模块和子目录。
  • __init__.py: 初始化文件，使该目录成为一个 Python 包。
  • admin.py: Django 管理后台的配置文件。
  • apps.py: 应用的配置文件。
  • fields.py: 自定义字段定义文件。
  • forms.py: 表单定义文件。
  • models.py: 数据库模型定义文件。
  • settings.py: 应用的配置文件。
  • templatetags/: 模板标签目录。
    • extra_settings.py: 自定义模板标签定义文件。
  • tests/: 测试代码目录。
    • test_*.py: 各个模块的测试文件。
  • urls.py: URL 路由配置文件。
  • views.py: 视图函数定义文件。
• manage.py: Django 项目的管理脚本。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖包列表。
• setup.py: 项目打包和安装脚本。
• tox.ini: 自动化测试配置文件。

2. 项目的启动文件介绍

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

使用方法

# 启动开发服务器
python manage.py runserver

# 运行测试
python manage.py test

# 创建数据库迁移
python manage.py makemigrations

# 应用数据库迁移
python manage.py migrate

3. 项目的配置文件介绍

项目的配置文件主要位于 django_extra_settings/settings.py 中。这个文件包含了应用的各种配置选项。

主要配置项

• EXTRA_SETTINGS_ADMIN_APP: 管理后台应用的名称。
• EXTRA_SETTINGS_CACHE_NAME: 缓存名称，如果未找到则使用默认缓存。
• EXTRA_SETTINGS_DEFAULTS: 默认设置列表，每个设置项必须包含 name、type 和 value。
• EXTRA_SETTINGS_ENFORCE_UPPERCASE_SETTINGS: 是否强制设置名称使用大写字母。
• EXTRA_SETTINGS_FALLBACK_TO_CONF_SETTINGS: 是否回退到 Django 配置设置。
• EXTRA_SETTINGS_FILE_UPLOAD_TO: 文件上传路径。
• EXTRA_SETTINGS_IMAGE_UPLOAD_TO: 图片上传路径。
• EXTRA_SETTINGS_SHOW_NAME_PREFIX_LIST_FILTER: 是否在管理后台显示名称前缀列表过滤器。

示例配置

EXTRA_SETTINGS_ADMIN_APP = "extra_settings"
EXTRA_SETTINGS_CACHE_NAME = "extra_settings"
EXTRA_SETTINGS_DEFAULTS = [
    {
        "name": "SETTING_NAME",
        "type": "string",
        "value": "Hello World",
    },
]
EXTRA_SETTINGS_ENFORCE_UPPERCASE_SETTINGS = True
EXTRA_SETTINGS_FALLBACK_TO_CONF_SETTINGS = True
EXTRA_SETTINGS_FILE_UPLOAD_TO = "files"
EXTRA_SETTINGS_IMAGE_UPLOAD_TO = "images"
EXTRA_SETTINGS_SHOW_NAME_PREFIX_LIST_FILTER = True

通过这些配置项，可以灵活地管理和定制 Django Extra Settings 的行为。

django-extra-settings:gear: config and manage typed extra settings using just the django admin.项目地址:https://gitcode.com/gh_mirrors/dj/django-extra-settings