pipreqs 项目技术文档

pipreqs 项目技术文档

pipreqs pipreqs - Generate pip requirements.txt file based on imports of any project. Looking for maintainers to move this project forward. 项目地址: https://gitcode.com/gh_mirrors/pi/pipreqs

1. 安装指南

1.1 安装 pipreqs

要安装 pipreqs，您可以使用以下命令：

pip install pipreqs

1.2 安装不支持 Jupyter Notebook 的版本

如果您不需要支持 Jupyter Notebook，可以通过以下命令安装 pipreqs，并排除相关依赖：

pip install --no-deps pipreqs
pip install yarg==0.1.9 docopt==0.6.2

2. 项目使用说明

2.1 基本用法

pipreqs 用于为基于导入的项目生成 requirements.txt 文件。您可以通过以下命令在指定目录中生成 requirements.txt 文件：

pipreqs /home/project/location

成功后，requirements.txt 文件将保存在 /home/project/location 目录下。

2.2 常用选项

• --use-local：仅使用本地包信息，不查询 PyPI。
• --pypi-server <url>：使用自定义的 PyPI 服务器。
• --proxy <url>：使用代理，参数将传递给 requests 库。
• --debug：打印调试信息。
• --ignore <dirs>...：忽略额外的目录，每个目录用逗号分隔。
• --no-follow-links：不跟随项目中的符号链接。
• --encoding <charset>：为文件打开使用编码参数。
• --savepath <file>：将需求列表保存在指定文件中。
• --print：将需求列表输出到标准输出。
• --force：覆盖现有的 requirements.txt 文件。
• --diff <file>：比较 requirements.txt 中的模块与项目导入的模块。
• --clean <file>：清理 requirements.txt，移除未在项目中导入的模块。
• --mode <scheme>：启用动态版本控制，支持 <compat>、<gt> 或 <non-pin> 方案。
• --scan-notebooks：在 Jupyter Notebook 文件中查找导入。

3. 项目 API 使用文档

pipreqs 主要通过命令行接口（CLI）进行操作，没有提供具体的 API 接口。您可以通过命令行选项来控制其行为。

4. 项目安装方式

4.1 通过 pip 安装

最简单的安装方式是通过 pip 安装：

pip install pipreqs

4.2 安装不支持 Jupyter Notebook 的版本

如果您不需要支持 Jupyter Notebook，可以通过以下命令安装 pipreqs，并排除相关依赖：

pip install --no-deps pipreqs
pip install yarg==0.1.9 docopt==0.6.2

5. 为什么不用 pip freeze？

• pip freeze 仅保存环境中通过 pip install 安装的包。
• pip freeze 会保存环境中的所有包，包括那些不在当前项目中使用的包（如果没有使用 virtualenv）。
• 有时您只需要为新项目创建 requirements.txt 文件，而不需要安装模块。

通过 pipreqs，您可以更精确地生成项目所需的依赖列表，避免不必要的包被包含在 requirements.txt 中。

pipreqs pipreqs - Generate pip requirements.txt file based on imports of any project. Looking for maintainers to move this project forward. 项目地址: https://gitcode.com/gh_mirrors/pi/pipreqs