pipreqs: 生成 python 项目的 requirements



版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文链接：http://blog.csdn.net/crisschan



项目开发的时候，总是要搭建和部署环境，这时，就需要一个python第三方包的list，一般叫做requirements.txt。如果项目使用virtualenv环境，直接使用pip freeze即可，但是如果项目的依赖没有维护，就会很麻烦，这时我们就需要一个叫pipreqs的工具，可以帮助我们自动生成requirements.txt文件。但是如果我们直接使用pip的下面命令生成对应的该文件$ pip freeze > requirements.txt,就会出现把开发机中全部的安装的库都引入进去。



pipreqs是个好工具

这个工具的好处是可以通过对项目目录的扫描，使用pipreqs的好处是可以通过对项目目录的扫描，发现使用了哪些库，生成依赖清单。缺点是可能会有些偏差，需要检查并自己调整下。



pipreqs使用

需要先安装：



pip install pipreqs



在项目的根目录下 使用 pipreqs ./



pipreqs ./ --encoding=utf8



特别注意：

• 在项目的根目录下使用 pipreqs ./

• 如果是Windows系统，会报编码错误 (UnicodeDecodeError: 'gbk' codec can't decode byte 0xa8 in position 24: illegal multibyte sequence) ，解决办法，指定编码格式 pipreqs ./ --encoding=utf8



requirements.txt 如何使用

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



pip install -r requriements.txt 

具体pipreqs的用法可以查看命令的帮助。