No --scan-notebooks option available

[jnareb]

I have installed pipreqs using python -m pip install pipreqs into local virtual environment... and it lacks --scan-notebooks option.

I have manually installed required dependencies (nbconvert and ipython), but it still does not work:

$ pipreqs --version
0.4.13
$ pipreqs --print --scan-notebooks --ignore .venv notebooks/
Usage:
    pipreqs [options] [<path>]
$ pipreqs --help
pipreqs - Generate pip requirements.txt file based on imports

Usage:
    pipreqs [options] [<path>]

Arguments:
    <path>                The path to the directory containing the application
                          files for which a requirements file should be
                          generated (defaults to the current working
                          directory).

Options:
    --use-local           Use ONLY local package info instead of querying PyPI.
    --pypi-server <url>   Use custom PyPi server.
    --proxy <url>         Use Proxy, parameter will be passed to requests
                          library. You can also just set the environments
                          parameter in your terminal:
                          $ export HTTP_PROXY="http://10.10.1.10:3128"
                          $ export HTTPS_PROXY="https://10.10.1.10:1080"
    --debug               Print debug information
    --ignore <dirs>...    Ignore extra directories, each separated by a comma
    --no-follow-links     Do not follow symbolic links in the project
    --encoding <charset>  Use encoding parameter for file open
    --savepath <file>     Save the list of requirements in the given file
    --print               Output the list of requirements in the standard
                          output
    --force               Overwrite existing requirements.txt
    --diff <file>         Compare modules in requirements.txt to project
                          imports
    --clean <file>        Clean up requirements.txt by removing modules
                          that are not imported in project
    --mode <scheme>       Enables dynamic versioning with <compat>,
                          <gt> or <non-pin> schemes.
                          <compat> | e.g. Flask~=1.1.2
                          <gt>     | e.g. Flask>=1.1.2
                          <no-pin> | e.g. Flask

[JanBremec]

0.4.13 is outdated — 0.5.0 was released in February 2024 and that's the version that added --scan-notebooks (along with nbconvert and ipython as required dependencies). You just need to upgrade:

pip install --upgrade pipreqs

Then verify with pipreqs --version that you're on 0.5.0, and the flag should appear in --help.

If you'd still prefer a runtime-based approach that also catches dynamic and conditional imports (which static scanning misses regardless of version), I built envcore — disclosing it's my own project:

pip install envcore
envcore notebook notebooks/your_notebook.ipynb