Find packages that should or should not be in requirements for a project
This is a fork of r1chardj0n3s/pip-check-reqs. I have no intention of maintaining this in the long-term. This exists to work around a current bug, at https://github.com/r1chardj0n3s/pip-check-reqs/pull/22, and to publish a fixed version to PyPI.
It happens: you start using a module in your project and it works and you don’t realise that it’s only being included in your virtualenv because it’s a dependency of a package you’re using. pip-missing-reqs finds those modules so you can include them in the requirements.txt for the project.
Alternatively, you have a long-running project that has some packages in requirements.txt that are no longer actively used in the codebase. The pip-extra-reqs tool will find those modules so you can remove them.
Assuming your project follows a layout like the suggested sample project:
setup.py setup.cfg requirements.txt sample/__init__.py sample/sample.py sample/tests/test_sample.py
Basic usage, running in your project directory:
<activate virtualenv for your project> pip-missing-reqs --ignore-file=sample/tests/* sample pip-extra-reqs --ignore-file=sample/tests/* sample
This will find all imports in the code in “sample” and check that the packages those modules belong to are in the requirements.txt file.
Additionally it is possible to check that there are no dependencies in requirements.txt that are then unused in the project:
<activate virtualenv for your project> pip-extra-reqs --ignore-file=sample/tests/* sample
This would find anything that is listed in requirements.txt but that is not imported by sample.
Sample tox.ini configuration
To make your life easier, copy something like this into your tox.ini:
[testenv:pip-check-reqs] deps=-rrequirements.txt commands= pip-missing-reqs --ignore-file=sample/tests/* sample pip-extra-reqs --ignore-file=sample/tests/* sample
Excluding test files (or others) from this check
Your test files will sometimes be present in the same directory as your application source (“sample” in the above examples). The requirements for those tests generally should not be in the requirements.txt file, and you don’t want this tool to generate false hits for those.
You may exclude those test files from your check using the –ignore-file option (shorthand is -f). Multiple instances of the option are allowed.
Excluding modules from the check
If your project has modules which are conditionally imported, or requirements which are conditionally included, you may exclude certain modules from the check by name (or glob pattern) using –ignore-module (shorthand is -m):
# ignore the module spam pip-missing-reqs --ignore-module=spam sample # ignore the whole package spam as well pip-missing-reqs --ignore-module=spam --ignore-module=spam.* sample
With Thanks To
Josh Hesketh – who refactored code and contributed the pip-extra-reqs tool.
Wil Cooley – who handled the removal of normalize_name and fixed some bugs.
- handled removal of normalize_name from pip.utils
- handle packages with no files
2.0 renamed package to pip_check_reqs
- added tool pip-extra-reqs to find packages installed but not used (contributed by Josh Hesketh)
- relax requirement to 6.0+
- bumped pip requirement to 6.0.8+
- updated use of pip internals to match that version
- test fixes and cleanup
- remove hard-coded simplejson debugging behaviour
- use os.path.realpath to avoid symlink craziness on debian/ubuntu
- tweak to debug output
- add debug (very verbose) run output
- add header to output to make it clearer when in a larger test run
- fix tests and self-test
- add –version
- remove debug print from released code lol
- fix program to generate exit code useful for testing
- corrected version of vendored search_packages_info() from pip
- handle relative imports
- fixed handling of import from __future__
- self-tested and added own requirements.txt
- cleaned up usage to require a file or directory to scan (rather than defaulting to “.”)
- vendored code from pip 1.6dev which fixes bug in search_packages_info until pip 1.6 is released
- implemented –ignore-module
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size pip_check_reqs_pip_gte_20-184.108.40.206-py2.py3-none-any.whl (10.2 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View|
|Filename, size pip_check_reqs_pip_gte_20-220.127.116.11.tar.gz (8.4 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for pip_check_reqs_pip_gte_20-18.104.22.168-py2.py3-none-any.whl
Hashes for pip_check_reqs_pip_gte_20-22.214.171.124.tar.gz