Python项目快速生成依赖文件requirements.txt

一、目的

应用程序通常需要设置安装所需并依赖一组类库来满足工作要求。要求文件是指定和一次性安装包的依赖项具体一整套方法。主要用于类库转移。

简单而言，当我们做Python项目时，把项目依赖的外部库以及版本列出来，方便后续维护，也为其他使用项目的人提供环境配置参考。

二、requirements.txt文件格式

requests==1.2.0 
Flask==0.10.1

三、安装依赖文件命令

pip install -r requirements.txt

四、生成requirements.txt

1、方法一：pip freeze

在项目所在目录，运行以下命令：

pip freeze > requirements.txt

pip的freeze命令用于生成将当前项目的pip类库列表生成 requirements.txt 文件

2、方法二：pipreqs

需要先安装pipreqs库：
pip install pipreqs
在项目所在文件夹，使用以下命令：
pipreqs DIR(需要生成配置文件的目录路径） --encoding=utf8

注意：若不加–encoding=utf8，可能出现如下编码错误：

UnicodeDecodeError: 'gbk' codec can't decode byte 0xaa in position 29: illegal multibyte sequence

3、区别

• 使用pip freeze保存的是当前Python环境下所有的类库；
• 使用pipreqs它会根据当前目录下的项目的依赖来导出三方类库；

4、使用建议

个人比较习惯使用pipreqs,因为他只会生成第三方库，不会列出自带库，查看、使用别人开源项目，配置环境时会比较方便。