Skip to main content

Find packages that should be in requirements for a project

Project description

Find packages that should be in requirements for a project.

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-files=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.

Sample tox.ini configuration

To make your life easier, copy something like this into your tox.ini:

[pip-missing-reqs]
deps=-rrequirements.txt
commands=pip-missing-reqs --ignore-files=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-files option.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pip_missing_reqs-1.0.0.tar.gz (5.9 kB view hashes)

Uploaded Source

Built Distribution

pip_missing_reqs-1.0.0-py2.py3-none-any.whl (8.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page