# pytemplate

**Repository Path**: david-woo/pytemplate

## Basic Information

- **Project Name**: pytemplate
- **Description**: pytemplate
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-14
- **Last Updated**: 2026-06-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PYTHON项目模板

为了统一python项目的代码及结构规范。

## 介绍

* 在用Django框架以及Django REST Framework框架。
* 引入swagger，便于本地调试和给调用者提供开发文档的作用。

## 目录结构说明

```text
├── /application                    # 框架层级的通用代码（包括配置代码）
├── /application/settings.py        # Django的环境配置文件
├── /application/url.py             # Django的路径映射配置
├── /application/utils              # 全局的通用工具，视图对象、日志配置、异常处理、接口监听等
├── /conf                           # 配置信息，把应用中容易发生变化的配置从settings中抽取到这里，统一管理
├── /conf/env.py                    # 环境配置，如数据库、redis、应用名称等配置
├── /demo                           # 示例代码
├── /demo/migrations                # 该子应用的一些初始化脚本(由python manager makemigrations 和 python manager migrate触发调用)
├── /demo/admin.py                  # 注册数据库,可在Django的Admin中进行管理
├── /demo/apps.py                   # 当前子应用的一些配置
├── /demo/models.py                 # 数据库的model定义
├── /demo/serializers.py            # DRF框架的序列化对象
├── /demo/dtos.py                   # 接口传输的需要的对象,如VO,BO,DTO等
├── /demo/tests.py                  # 测试代码
├── /demo/urls.py                   # 接口url定义
├── /demo/views.py                  # 业务代码的实现
├── /static                         # 静态文件目录
├── /templates                      # 页面的模板文件目录
└── /requirements.txt               # 项目的包依赖管理
```

## 内置功能

* 统一的响应规范
* 统一的日志输出格式化
* 统一的异常处理

## 准备工作

```text
Python >= 3.6.0 (推荐3.8+版本)
```

### 后端

```markdown
1. 在项目根目录中，复制 ./conf/env.example.py 文件为一份新的到 ./conf 文件夹下，并重命名为 env.py
2. 在 env.py 中配置数据库信息
   mysql数据库版本建议：8.0
   mysql数据库字符集：utf8mb4
3. 安装依赖环境
   pip3 install -r requirements.txt
4. 执行迁移命令：
   python3 manage.py makemigrations
   python3 manage.py migrate
5. 初始化数据(如果使用django内置的授权)
   python3 manage.py createsuperuser
6. 启动项目
   python3 manage.py runserver 0.0.0.0:8000
```

### 访问项目

- 访问地址：[http://localhost:8080](http://localhost:8080) (默认为此地址，如有修改请按照配置文件)