pipreqs

0.5.0 · active · verified Sun Apr 12

pipreqs is a Python utility that automatically generates a `requirements.txt` file for a project based on the import statements found in its Python files and Jupyter notebooks. It aims to create a clean, minimal list of direct dependencies, avoiding the inclusion of unused packages or the entire environment as `pip freeze` does. The current version is 0.5.0, and releases occur irregularly, with significant updates like Jupyter support recently added.

Warnings

breaking Python version compatibility has changed. Older versions of pipreqs supported Python 3.7+, but as of v0.5.0, it requires Python >=3.8.1.
Fix: Ensure your project runs on Python 3.8.1 or newer when using pipreqs v0.5.0+. For older Python versions, use an older pipreqs release.
gotcha pipreqs may include irrelevant packages if virtual environment folders (`.venv`, `env`, etc.) are not explicitly ignored, as it scans all `.py` files in the specified path.
Fix: Always use the `--ignore` option to exclude virtual environment directories, e.g., `pipreqs . --ignore .venv,env`.
gotcha Module-to-package mapping issues can lead to incorrect or missing package names (e.g., `kafka` instead of `kafka-python`, or `azure` modules). While mappings are frequently updated, manual intervention may sometimes be necessary.
Fix: Review the generated `requirements.txt` file and manually correct any misidentified packages. Contribute to the `pipreqs` mapping file on GitHub if you find a common error.
gotcha pipreqs primarily detects direct imports. It may not include indirect dependencies (packages required by your direct imports but not explicitly imported in your code) or specific plugins that are only used implicitly.
Fix: After generating the `requirements.txt`, perform a test installation and run your project to identify any missing indirect dependencies or plugins. Add them manually to the `requirements.txt` file.
gotcha By default, pipreqs will not overwrite an existing `requirements.txt` file, preventing accidental data loss.
Fix: Use the `--force` flag to explicitly overwrite an existing `requirements.txt` file: `pipreqs . --force`.

Install

pip install pipreqs Install pipreqs

Quickstart

To generate a `requirements.txt` file, navigate to your project's root directory and run `pipreqs .`. If your project includes Jupyter notebooks, use the `--scan-notebooks` flag. You can also preview the requirements without saving by using `--print`.

# Navigate to your project's root directory
# Generate requirements.txt for Python files:
pipreqs .

# Generate requirements.txt including Jupyter notebooks:
pipreqs . --scan-notebooks

# To print to console without saving to file:
pipreqs . --print

view raw JSON →