academic

软件包说明

pymysql 用于连接数据库

pyyaml 用于读取配置文件

配置文件说明

secrets.yaml

用于存放不易上传的账号密码等信息，如数据库账号密码，邮箱账号密码等不需要上传至仓库，但是需要在本地运行的信息, 请在本地创建该文件，参考格式如下：

DATABASE:
  name : xxx
  host : xxx
  port : xxx
  user : xxx
  password : xxx

在setting.py文件中的调用方法：

import yaml
with open(BASE_DIR / 'secrets.yaml', 'r') as f:
    secrets = yaml.load(f, Loader=yaml.FullLoader)
    databases_name = secrets['DATABASE']['name']
    databases_user = secrets['DATABASE']['user']
    databases_password = secrets['DATABASE']['password']
    databases_host = secrets['DATABASE']['host']
    databases_port = secrets['DATABASE']['port']

运行时，需要将该文件存放位置为项目文件夹下，与manage.py文件夹同级

不要将该文件上传至Github仓库

运行说明

运行指令：

python manage.py makemigrations # 生成迁移文件
python manage.py migrate # 迁移数据库
python manage.py createsuperuser # 创建超级用户(可选)
python manage.py runserver # 运行

项目说明

项目结构

├── academic
│   ├── __init__.py
│   ├── __pycache__
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   ├── wsgi.py
├── my_app
│   ├── migrations
│   ├── __init__.py
│   ├── __pycache__
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── tests.py
│   ├── urls.py
│   ├── views.py
├── templates
├── manage.py
├── README.md
├── secrets.yaml

xiao21wei/academic