Metadata-Version: 1.1
Name: Requirementz
Version: 0.3.0
Summary: Checks pip requirements against installed versions, and other related tools.

Home-page: https://github.com/welbornprod/requirementz
Author: Christopher Welborn
Author-email: cj@welbornprod.com
License: UNKNOWN
Description: Requirementz
        ============
        
        -  Checks ``requirements.txt`` against installed packages, or latest
           versions available on PyPi.
        
        -  Shows latest package information from PyPi (for ``requirements.txt``
           or any package).
        
        -  Searches ``requirements.txt`` for text/regex patterns.
        
        -  Sorts ``requirements.txt`` lines in place.
        
        -  Finds duplicate entries in ``requirements.txt``.
        
        Usage
        -----
        
        ::
        
            Usage:
                requirementz (-h | -v) [-D] [-n]
                requirementz [-c | -C] [-e] [-L | -r] [-f file] [-D] [-n]
                requirementz [-a line... | -d]        [-f file] [-D] [-n]
                requirementz -l [-L | -r]             [-f file] [-D] [-n]
                requirementz (-P | -S)                [-f file] [-D] [-n]
                requirementz -p [-L]                            [-D] [-n]
                requirementz -s pat [-i]              [-f file] [-D] [-n]
                requirementz PACKAGE...                         [-D] [-n]
        
            Options:
                PACKAGE              : Show pypi info for package names.
                -a line,--add line   : Add a requirement line to the file.
                                       The -a flag can be used multiple times.
                -C,--checklatest     : Check installed packages and latest versions
                                       from PyPi against requirements.
                -c,--check           : Check installed packages against requirements.
                -D,--debug           : Print some debug info while running.
                -d,--duplicates      : List any duplicate entries.
                -e,--errors          : Only show packages with errors when checking.
                -f file,--file file  : Requirements file to parse.
                                       Default: ./requirements.txt
                -h,--help            : Show this help message.
                -i,--ignorecase      : Case insensitive when searching.
                -L,--location        : When listing, sort by location instead of name.
                                       When checking, show the package location.
                -l,--list            : List all requirements.
                -n,--nocolor         : Force plain text, with no color codes.
                -P,--pypi            : Show pypi info for all packages in
                                       requirements.txt.
                -p,--packages        : List all installed packages.
                -r,--requirement     : Print name and version requirement only for -c.
                                       Useful for use with -e, to get a list of
                                       packages to install or upgrade.
                -S,--sort            : Sort the requirements file by package name.
                -s pat,--search pat  : Search requirements for text/regex pattern.
                -v,--version         : Show version.
        
        Examples
        --------
        
        Check (installed packages)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Check ``requirements.txt`` against installed package versions.
        
        .. code:: bash
        
            requirementz
        
        Here you can see that the ``colr >= 0.7.6`` requirement was not
        satisfied, because ``0.7.5`` is installed: |Output|
        
        Show package location while checking:
        
        .. code:: bash
        
            requirementz -L
        
        .. figure:: http://imgur.com/szaquw9.png
           :alt: Output
        
           Output
        
        Check (latest pypi version)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Check ``requirements.txt`` against installed package versions, and the
        latest pypi version.
        
        .. code:: bash
        
            requirementz -C
        
        .. figure:: http://imgur.com/FEiyEgU.png
           :alt: Output
        
           Output
        
        Show package location while checking:
        
        .. code:: bash
        
            requirementz -C -L
        
        .. figure:: http://imgur.com/h7TgJ0u.png
           :alt: Output
        
           Output
        
        Show pypi info for packages.
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        ``-P`` will show pypi information for all packages in
        ``requirements.txt``:
        
        .. code:: bash
        
            requirementz -P
        
        .. figure:: http://imgur.com/nxjGyK7.png
           :alt: Output
        
           Output
        
        You can do this for any package, whether it's installed or not:
        
        .. code:: bash
        
            requirementz antigravity
        
        .. figure:: http://imgur.com/hFXbf8C.png
           :alt: Output
        
           Output
        
        You can use more than one package name.
        
        Find duplicate requirements
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Any duplicate entries will be listed by name, with a count of
        duplicates.
        
        .. code:: bash
        
            requirementz -d
        
        Notes
        -----
        
        This hasn't been tested very well with CVS or local requirements. Any
        help in that area would be appreciated, as I haven't had to use those
        requirement types.
        
        File an issue or create a pull request. Contributions are welcome.
        
        .. |Output| image:: http://imgur.com/nbzLv7X.png
        
        
Keywords: python module library 3 pip requirements requirements.txt
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
