============================================================================= pipreqs - 根据导入生成任何项目的 requirements.txt 文件

.. image:: https://img.shields.io/travis/bndr/pipreqs.svg :target: https://travis-ci.org/bndr/pipreqs

.. image:: https://img.shields.io/pypi/v/pipreqs.svg :target: https://pypi.python.org/pypi/pipreqs

.. image:: https://codecov.io/gh/bndr/pipreqs/branch/master/graph/badge.svg?token=0rfPfUZEAX :target: https://codecov.io/gh/bndr/pipreqs

.. image:: https://img.shields.io/pypi/l/pipreqs.svg :target: https://pypi.python.org/pypi/pipreqs

安装

.. code-block:: sh

pip install pipreqs

注意：如果你不需要支持 Jupyter notebooks，你可以在不安装相关依赖的情况下安装 pipreqs。 要这样做，请运行：

.. code-block:: sh

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

使用方法

::

用法：
    pipreqs [选项] [<路径>]

参数：
    <路径>                包含应用程序文件的目录路径，用于生成 requirements 文件
                          （默认为当前工作目录）

选项：
    --use-local           仅使用本地包信息，而不查询 PyPI
    --pypi-server <url>   使用自定义 PyPi 服务器
    --proxy <url>         使用代理，参数将传递给 requests 库。你也可以直接在终端中
                          设置环境参数：
                          $ export HTTP_PROXY="http://10.10.1.10:3128"
                          $ export HTTPS_PROXY="https://10.10.1.10:1080"
    --debug               打印调试信息
    --ignore <dirs>...    忽略额外的目录，每个目录用逗号分隔
    --no-follow-links     不跟随项目中的符号链接
    --encoding <charset>  为文件打开使用编码参数
    --savepath <file>     将 requirements 列表保存在指定文件中
    --print               在标准输出中输出 requirements 列表
    --force               覆盖现有的 requirements.txt
    --diff <file>         比较 requirements.txt 中的模块与项目导入
    --clean <file>        通过删除项目中未导入的模块来清理 requirements.txt
    --mode <scheme>       启用动态版本控制，使用 <compat>、<gt> 或 <non-pin> 方案
                          <compat> | 例如 Flask~=1.1.2
                          <gt>     | 例如 Flask>=1.1.2
                          <no-pin> | 例如 Flask
    --scan-notebooks      在 Jupyter notebook 文件中查找导入

示例

::

$ pipreqs /home/project/location
成功保存 requirements 文件到 /home/project/location/requirements.txt

requirements.txt 的内容

::

wheel==0.23.0
Yarg==0.1.9
docopt==0.6.2

为什么不使用 pip freeze？

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