pip-check

Check for broken or missing requirements

$ pip check

$ pip check --log [path/to/file]

pip check [global-options]

--verbose
    Gives more output, which can be useful for debugging or detailed analysis.

--disable-pip-version-check
    Do not periodically check PyPI to determine whether a new version of pip is available for download. Implied when `PIP_NO_PIP_VERSION_CHECK` is set.

--no-color
    Suppress colored output, which can be helpful when redirecting output to a file or in environments that do not support ANSI escape codes.

The pip check command is a utility within the pip package installer for Python that verifies the consistency and compatibility of currently installed packages. Its primary function is to scan your Python environment and report any issues concerning package dependencies, such as unsatisfied requirements or conflicting versions.

When executed, pip check examines each installed package's declared dependencies and compares them against other packages present in the environment. If it finds a package that requires another package that is either missing or installed at an incompatible version, it will output a clear report detailing these discrepancies.

This command is invaluable for diagnosing problems in a Python environment, helping developers and system administrators quickly identify the root cause of 'ModuleNotFoundError' or unexpected behavior due to dependency conflicts. It acts as a quick health check for your installed Python packages, ensuring that all pieces are in place and compatible with one another. However, it's important to note that pip check only reports problems; it does not attempt to resolve or fix them automatically.

pip check is a diagnostic tool and does not attempt to resolve or fix dependency issues. Users must manually address any reported problems, typically by installing missing packages or updating/downgrading conflicting ones. It only verifies declared dependencies against installed packages; it does not validate against a requirements.txt file or check for conditional runtime dependencies that might not be declared statically.

The output of pip check is straightforward. It lists each package that has a dependency issue, followed by a description of the problem. For example, 'package-name requires another-package, which is not installed.' or 'package-name has requirement another-package==X.Y.Z, but you have another-package A.B.C installed.' If no output is displayed, it means all installed packages have their dependencies satisfied and no immediate conflicts were found.

The pip check subcommand was introduced as part of the ongoing development of pip, the standard package installer for Python. Its inclusion aimed to provide Python developers and administrators with a quick, built-in method to diagnose common dependency conflicts and missing packages within their Python environments, improving the overall stability and reliability of package management.

pip(1), pip install(1), pip uninstall(1), pip list(1)