目录

一、 维护项目相关的依赖包

二、创建本地配置文件和公共配置文件

三、创建README.md文件

---

一、 维护项目相关的依赖包

1. 目的：别人下载并运行你的项目时，需要安装依赖包才能正常运行项目

2. 解决方案：在项目根目录下，创建文件requirements.txt，可以手动创建，也可以使用命令创建

命令：pip freeze > requirements.txt

3. requirements.txt的内容一般如下，等号左边是依赖包名称，右边是版本号

pytest==5.4.3
requests==2.22.0
xlrd==2.0.1
xlutils==2.0.0

4. 手动创建时，根据pycharm中的“Project Interpreter”列表中的“Package”和“Version”创建

5. 用命令创建时，需要以下两个命令，#后面是注释信息

pip3 install pipreqs  # 安装pipreqs

pipreqs ./   #生成requirements.txt文件

6. 利用requirements.txt，安装项目运行环境所需依赖：

pip3 install -r requirements.txt

二、创建本地配置文件和公共配置文件

1. 目的：有些敏感信息，比如密码等，不能共享给别人，所以需要创建本地配置文件local_settings.py，维护真实的数据；而公共配置文件settings.py维护与local_settings.py一样的常量名称，但填写假的数据，且导入local_settings

2. local_settings.py内容大概如下：

ACCOUNT = '123@qq.com'  # 真实的账号
PASSWORD = "456"  # 真实的密码

3. 在.gitignore中维护local_settings.py，上传至git时会忽略该文件

# 忽略本地配置文件
local_settings.py

4. 与.gitignore文件类似，.git/info 下面的exclude文件，也可以维护需要忽略的文件或者文件夹

5. settings.py内容大概如下:

ACCOUNT = 'XXX'  # 假的账号，值可为空
PASSWORD = "XXX"  # 假的密码，值可为空

# 导入local_settings，让local_settings中的值覆盖该文件中的值
try:
    from local_settings import *
except:
    pass

6. 本地项目使用配置文件中常量的方式，先导入文件，再引用常量：

import settings

account = settings.ACCOUNT
password = settings.PASSWORD

三、创建README.md文件

该文件是 markdown 文本格式，内容包括：项目简介、主要功能介绍和使用方式等