Metadata-Version: 2.0
Name: pip-utils
Version: 0.0.2
Summary: Helper utilities for pip
Home-page: https://github.com/brbsix/pip-utils
Author: Brian Beffa
Author-email: brbsix@gmail.com
License: GPLv3
Keywords: package,packaging,pip,PyPi
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: System
Classifier: Topic :: System :: Software Distribution
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Dist: pip
Provides-Extra: testing
Requires-Dist: pytest-pylint; extra == 'testing'

pip-utils
---------

Helper utilities for pip.


Installation
============

::

    pip install --user pip-utils


Usage
=====

::

    usage: pip3-utils [-h] [--version]
                      {dependants,dependents,locate,outdated,parents} ...

    Helper utilities for pip.

    positional arguments:
      {dependants,dependents,locate,outdated,parents}
        dependants          list dependants of package
        dependents          list dependents of package
        locate              identify package that file belongs to
        outdated            list outdated packages that may be updated
        parents             list packages lacking dependants

    optional arguments:
      -h, --help            show this help message and exit
      --version             show program's version number and exit

    See `pip3-utils COMMAND --help` for help on a specific subcommand.

For Python 2, use ``pip2-utils``. For Python 3, use ``pip3-utils``. Or, use ``python -m pip_utils``.


Commands
========

List dependants of a package:

::

    $ pip3-utils dependants pexpect
    ipython

List direct dependents of a package:

::

    $ pip3-utils dependents ipython
    backports.shutil-get-terminal-size
    decorator
    pexpect
    pickleshare
    setuptools
    simplegeneric
    traitlets

List direct dependents of a package with their version requirements:

::

    $ pip3-utils dependents -i dataset
    alembic>=0.6.2
    normality>=0.2.2
    PyYAML>=3.10
    six
    six>=1.7.3
    sqlalchemy>=0.9.1

List all dependencies of a package recursively:

::

    $ pip3-utils dependents -r dataset
    alembic
    Mako
    MarkupSafe
    normality
    python-editor
    PyYAML
    six
    SQLAlchemy

Identify package(s) that file belongs to:

::

    $ pip3-utils locate ~/.local/bin/symilar
    pylint

List outdated packages that may be updated. Note, this differ's from pip's ``--outdated`` flag in that it verifies that there are no conflicting dependencies that would otherwise make an update inadvisable.

::

    pip3-utils outdated

List all outdated packages. Note, this is equivalent to pip's ``--outdated`` flag.

::

    pip3-utils outdated --all

List outdated packages unable to be updated due to dependency requirements:

::

    pip3-utils outdated --pinned

List packages lacking dependants:

::

    pip3-utils parents


Development
===========

To run tests (automatically pulling in dependencies):

::

    python setup.py test

To run tests directly, with verbose output:

::

    python3 -m pytest -vv


License
=======

Copyright (c) 2015 Six (brbsix@gmail.com).

Licensed under the GPLv3 license.


