Metadata-Version: 1.1
Name: pip_missing_reqs
Version: 1.1.3
Summary: Find packages that should be in requirements for a project
Home-page: https://github.com/r1chardj0n3s/pip-missing-reqs
Author: Richard Jonees
Author-email: r1chardj0n3s@gmail.com
License: MIT
Description: pip-missing-reqs
        ================
        
        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. This tool finds those modules so
        you can include them in the `requirements.txt`_ for the project.
        
        .. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
        .. _`requirements.txt`: https://pip.pypa.io/en/latest/user_guide.html#requirements-files
        
        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
        
        .. _`sample project`: https://packaging.python.org/en/latest/tutorial.html#creating-your-own-project
        
        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.
        
        
        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-mods::
        
            # ignore the module spam
            pip-missing-reqs --ignore-mods=spam sample
            # ignore the whole package spam as well
            pip-missing-reqs --ignore-mods=spam --ignore-mods=spam.* sample
        Release History
        ---------------
        
        1.1.3
        - fix program to generate exit code useful for testing
        
        1.1.2
        - corrected version of vendored search_packages_info() from pip
        - handle relative imports
        
        1.1.1
        - 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
        
        1.1.0 
        - implemented --ignore-module
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
