Django-Fernet-Fields 项目教程

Django-Fernet-Fields 项目教程

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

django-fernet-fields/
├── django_fernet_fields/
│   ├── __init__.py
│   ├── fields.py
│   ├── forms.py
│   ├── models.py
│   ├── utils.py
│   └── widgets.py
├── tests/
│   ├── __init__.py
│   ├── settings.py
│   ├── test_fields.py
│   └── test_models.py
├── .gitignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── requirements.txt
├── setup.cfg
├── setup.py
└── tox.ini

目录结构介绍

• django_fernet_fields/: 核心模块目录，包含所有加密字段相关的代码。
  • __init__.py: 模块初始化文件。
  • fields.py: 定义加密字段类。
  • forms.py: 定义表单字段类。
  • models.py: 定义模型字段类。
  • utils.py: 工具函数。
  • widgets.py: 定义表单小部件。
• tests/: 测试模块目录，包含所有测试代码。
  • __init__.py: 测试模块初始化文件。
  • settings.py: 测试配置文件。
  • test_fields.py: 字段测试代码。
  • test_models.py: 模型测试代码。
• .gitignore: Git忽略文件配置。
• CHANGELOG.md: 项目变更日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包清单文件。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。
• tox.ini: 自动化测试配置文件。

2. 项目的启动文件介绍

项目没有特定的启动文件，因为它是一个库，而不是一个独立的应用程序。用户需要在他们的Django项目中集成并使用这个库。

3. 项目的配置文件介绍

settings.py

在Django项目的settings.py文件中，用户需要确保以下配置：

INSTALLED_APPS = [
    ...
    'django_fernet_fields',
    ...
]

requirements.txt

在Django项目的requirements.txt文件中，用户需要添加以下依赖：

django-fernet-fields

models.py

在Django项目的models.py文件中，用户可以定义使用加密字段的模型：

from django.db import models
from django_fernet_fields import EncryptedTextField

class MyModel(models.Model):
    name = EncryptedTextField()

通过以上配置，用户可以在Django项目中使用django-fernet-fields库来加密敏感数据。