基于pipreqs 对 Python 工程依赖包扫描

项目开发的时候，总是要搭建和部署环境，需要一个python第三方包的list，一般叫做requirements.txt。如果项目使用virtualenv环境，直接使用pip freeze即可，但是如果项目的依赖没有维护，就会很麻烦，这时我们就需要一个叫pipreqs的工具，可以帮助我们自动生成requirements.txt文件。

freeze 生成依赖列表文件

$ pip freeze > requirements.txt

该方式配合virtualenv 才好使，否则把整个环境中的包都列出来了。

pipreqs 生成依赖列表文件

安装

pip install pipreqs

用法

在项目的根目录下使用

pipreqs ./ 

如果是Windows系统，会报编码错误 (UnicodeDecodeError: ‘gbk’ codec can’t decode byte 0xa8 in position 24: illegal multibyte sequence)

使用时，指定编码格式

pipreqs ./ --encoding=utf8

生成 requirements.txt 文件后，可以根据这个文件下载所有的依赖

pip install -r requriements.txt

详细用法

pipreqs [options] <path>

选项：

--use-local仅使用本地包信息而不是查询PyPI
--pypi-server <url>使用自定义PyPi服务器
--proxy <url>使用Proxy，参数将传递给请求库。你也可以设置
终端中的环境参数：
$ export HTTP_PROXY =“http://10.10.1.10:3128”
$ export HTTPS_PROXY =“https://10.10.1.10:1080”
--debug打印调试信息
--ignore <dirs> ...忽略额外的目录
--encoding <charset>使用编码参数打开文件
--savepath <file>保存给定文件中的需求列表
--print输出标准输出中的需求列表
--force覆盖现有的requirements.txt
--diff <file>将requirements.txt中的模块与项目导入进行比较。
--clean <file>通过删除未在项目中导入的模块来清理requirements.txt

报错解决

安装后，由于python下Scripts目录未添加到环境变量会导致命令无法正常使用，如下图：
将Scripts环境加入到系统环境变量下的path属性里。

然后重新打开命令行再次执行命令进行扫描即可。