python工具-pipreqs 自动化生成requirements.txt文件
pip freeze 的问题
在开发 Python 项目时，requirements.txt 文件扮演着至关重要的角色，它记录了项目所需的所有外部库及其版本。传统上，我们使用 pip freeze 命令来生成这个文件，但它存在一些弊端： • 只记录已安装的库，无法体现项目实际使用情况。 如果项目中实际使用了某个库，但没有安装，pip freeze 就不会将它记录在 requirements.txt 中。 • 包含无关库，造成混乱。 pip freeze 会将当前环境下所有已安装的库都记录下来，即使它们并非项目所需。 • 缺乏灵活性，无法自定义版本控制。 pip freeze 只记录库的精确版本，无法根据项目需求灵活设定版本范围。 为了解决上述问题，pipreqs 应运而生！它是一个强大的工具，可以根据项目中的代码自动生成 requirements.txt 文件，并提供多种灵活的配置选项。
pipreqs
pipreqs 可以根据项目的代码自动生成 requirements.txt 文件。它会分析项目中所有 Python 文件（包括 *.py 和 Jupyter Notebook *.ipynb 文件），识别所有导入的库，并将其添加到 requirements.txt 文件中。
pipreqs 的用途
• 自动生成 requirements.txt 文件。 • 识别项目中实际使用的所有库。 • 提供多种灵活的配置选项，如版本控制策略、忽略目录等。 • 支持 Jupyter Notebook 文件的解析。
如何使用 pipreqs
- 1. 安装 pipreqs:
pip install pipreqs
- 2. 使用 pipreqs 生成 requirements.txt 文件:
pipreqs .
- 其中 [路径] 表示项目根目录的路径。例如，要为当前目录下的项目生成 requirements.txt 文件，可以使用命令：. 或者 ./
- 如果出现字符集问题，如系统是gbk，执行是可能会有错误。那么可以执行以下命令，指定字符集
pipreqs ./ --encoding=utf-8
举例说明
假设你的项目目录结构如下：
my_project/ ├── app.py ├── utils.py └── requirements.txt
其中 app.py 和 utils.py 文件中使用了 Flask 库：
# app.py from flask import Flask app = Flask(__name__) # ... # utils.py from flask import request, jsonify # ...
使用 pipreqs 生成 requirements.txt 文件：
pipreqs .
生成的 requirements.txt 文件内容如下：
Flask~=2.2.2
与 pip freeze 的区别
• pip freeze 只记录已安装的库，而 pipreqs 会识别项目中实际使用的所有库，即使它们尚未安装。 • pip freeze 会包含所有已安装的库，即使它们并非项目所需，而 pipreqs 只记录项目中实际使用的库。 • pip freeze 只记录库的精确版本，而 pipreqs 可以使用动态版本控制策略，更灵活地指定版本范围。
总结
pipreqs 是一个强大的工具，可以帮助你轻松地生成 requirements.txt 文件，并提供多种灵活的配置选项。它可以有效地简化项目管理流程，提高开发效率。
项目地址：GitHub - bndr/pipreqs: pipreqs - Generate pip requirements.txt file based on imports of any project. Looking for maintainers to move this project forward.