pip-review


Namepip-review JSON
Version 1.3.0 PyPI version JSON
download
home_pagehttps://github.com/jgonggrijp/pip-review
Summarypip-review lets you smoothly manage all available PyPI updates.
upload_time2022-11-29 16:45:35
maintainer
docs_urlNone
authorJulian Gonggrijp, Vincent Driessen
requires_python>=2.7, !=3.0, !=3.1, !=3.2
licenseBSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            .. image:: https://travis-ci.org/jgonggrijp/pip-review.svg?branch=master
    :alt: Build status
    :target: https://secure.travis-ci.org/jgonggrijp/pip-review

pip-review
==========

*Looking for a new maintainer! See https://github.com/jgonggrijp/pip-review/issues/76.*

``pip-review`` is a convenience wrapper around ``pip``. It can list available updates by deferring to ``pip list --outdated``. It can also automatically or interactively install available updates for you by deferring to ``pip install``.

Example, report-only:

.. code:: console

    $ pip-review
    requests==0.13.4 is available (you have 0.13.2)
    redis==2.4.13 is available (you have 2.4.9)
    rq==0.3.2 is available (you have 0.3.0)

Example, actually install everything:

.. code:: console

    $ pip-review --auto
    ... <pip install output>

Example, run interactively, ask to upgrade for each package:

.. code:: console

    $ pip-review --interactive
    requests==0.14.0 is available (you have 0.13.2)
    Upgrade now? [Y]es, [N]o, [A]ll, [Q]uit y
    ...
    redis==2.6.2 is available (you have 2.4.9)
    Upgrade now? [Y]es, [N]o, [A]ll, [Q]uit n
    rq==0.3.2 is available (you have 0.3.0)
    Upgrade now? [Y]es, [N]o, [A]ll, [Q]uit y
    ...

Run ``pip-review -h`` for a complete overview of the options.

Note: If you want to pin specific packages to prevent them from automatically
being upgraded, you can use a constraint file (similar to ``requirements.txt``):

.. code:: console

    $ export PIP_CONSTRAINT="${HOME}/constraints.txt
    $ cat $PIP_CONSTRAINT
    pyarrow==0.14.1
    pandas<0.24.0

    $ pip-review --auto
    ...

Set this variable in ``.bashrc`` or ``.zshenv`` to make it persistent.
Alternatively, this option can be specified in ``pip.conf``, e.g.:

* Linux:

.. code:: console

    $ cat ~/.config/pip/pip.conf
    [global]
    constraint = /home/username/constraints.txt
    
* Windows:

.. code:: console

    $ cat $HOME\AppData\Roaming\pip\pip.ini
    [global]
    constraint = '$HOME\Roaming\pip\constraints.txt'

The conf file are dependent of the user, so If you use multiple users you must define config file for each of them.
https://pip.pypa.io/en/stable/user_guide/#constraints-files

Since version 0.5, you can also invoke pip-review as ``python -m pip_review``. This can be useful if you are using multiple versions of Python next to each other.

Before version 1.0, ``pip-review`` had its own logic for finding package updates instead of relying on ``pip list --outdated``.

Like ``pip``, ``pip-review`` updates **all** packages, including ``pip`` and ``pip-review``.


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

To install, simply use pip:

.. code:: console

    $ pip install pip-review

Decide for yourself whether you want to install the tool system-wide, or
inside a virtual env.  Both are supported.


Testing
=======

To test with your active Python version:

.. code:: console

    $ ./run-tests.sh

To test under all (supported) Python versions:

.. code:: console

    $ tox

The tests run quite slow, since they actually interact with PyPI, which
involves downloading packages, etc.  So please be patient.


Origins
=======

``pip-review`` was originally part of pip-tools_ but
has been discontinued_ as such. See `Pin Your Packages`_ by Vincent
Driessen for the original introduction. Since there are still use cases, the
tool now lives on as a separate package.


.. _pip-tools: https://github.com/nvie/pip-tools/
.. _discontinued: https://github.com/nvie/pip-tools/issues/185
.. _Pin Your Packages: http://nvie.com/posts/pin-your-packages/
.. _cram: https://bitheap.org/cram/
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jgonggrijp/pip-review",
    "name": "pip-review",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=2.7, !=3.0, !=3.1, !=3.2",
    "maintainer_email": "",
    "keywords": "",
    "author": "Julian Gonggrijp, Vincent Driessen",
    "author_email": "j.gonggrijp@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/f7/e8/bcb143f21668de2c285ce3d73041ba035b2340fb44bdd95ee04b3e313d09/pip-review-1.3.0.tar.gz",
    "platform": "any",
    "description": ".. image:: https://travis-ci.org/jgonggrijp/pip-review.svg?branch=master\n    :alt: Build status\n    :target: https://secure.travis-ci.org/jgonggrijp/pip-review\n\npip-review\n==========\n\n*Looking for a new maintainer! See https://github.com/jgonggrijp/pip-review/issues/76.*\n\n``pip-review`` is a convenience wrapper around ``pip``. It can list available updates by deferring to ``pip list --outdated``. It can also automatically or interactively install available updates for you by deferring to ``pip install``.\n\nExample, report-only:\n\n.. code:: console\n\n    $ pip-review\n    requests==0.13.4 is available (you have 0.13.2)\n    redis==2.4.13 is available (you have 2.4.9)\n    rq==0.3.2 is available (you have 0.3.0)\n\nExample, actually install everything:\n\n.. code:: console\n\n    $ pip-review --auto\n    ... <pip install output>\n\nExample, run interactively, ask to upgrade for each package:\n\n.. code:: console\n\n    $ pip-review --interactive\n    requests==0.14.0 is available (you have 0.13.2)\n    Upgrade now? [Y]es, [N]o, [A]ll, [Q]uit y\n    ...\n    redis==2.6.2 is available (you have 2.4.9)\n    Upgrade now? [Y]es, [N]o, [A]ll, [Q]uit n\n    rq==0.3.2 is available (you have 0.3.0)\n    Upgrade now? [Y]es, [N]o, [A]ll, [Q]uit y\n    ...\n\nRun ``pip-review -h`` for a complete overview of the options.\n\nNote: If you want to pin specific packages to prevent them from automatically\nbeing upgraded, you can use a constraint file (similar to ``requirements.txt``):\n\n.. code:: console\n\n    $ export PIP_CONSTRAINT=\"${HOME}/constraints.txt\n    $ cat $PIP_CONSTRAINT\n    pyarrow==0.14.1\n    pandas<0.24.0\n\n    $ pip-review --auto\n    ...\n\nSet this variable in ``.bashrc`` or ``.zshenv`` to make it persistent.\nAlternatively, this option can be specified in ``pip.conf``, e.g.:\n\n* Linux:\n\n.. code:: console\n\n    $ cat ~/.config/pip/pip.conf\n    [global]\n    constraint = /home/username/constraints.txt\n    \n* Windows:\n\n.. code:: console\n\n    $ cat $HOME\\AppData\\Roaming\\pip\\pip.ini\n    [global]\n    constraint = '$HOME\\Roaming\\pip\\constraints.txt'\n\nThe conf file are dependent of the user, so If you use multiple users you must define config file for each of them.\nhttps://pip.pypa.io/en/stable/user_guide/#constraints-files\n\nSince version 0.5, you can also invoke pip-review as ``python -m pip_review``. This can be useful if you are using multiple versions of Python next to each other.\n\nBefore version 1.0, ``pip-review`` had its own logic for finding package updates instead of relying on ``pip list --outdated``.\n\nLike ``pip``, ``pip-review`` updates **all** packages, including ``pip`` and ``pip-review``.\n\n\nInstallation\n============\n\nTo install, simply use pip:\n\n.. code:: console\n\n    $ pip install pip-review\n\nDecide for yourself whether you want to install the tool system-wide, or\ninside a virtual env.  Both are supported.\n\n\nTesting\n=======\n\nTo test with your active Python version:\n\n.. code:: console\n\n    $ ./run-tests.sh\n\nTo test under all (supported) Python versions:\n\n.. code:: console\n\n    $ tox\n\nThe tests run quite slow, since they actually interact with PyPI, which\ninvolves downloading packages, etc.  So please be patient.\n\n\nOrigins\n=======\n\n``pip-review`` was originally part of pip-tools_ but\nhas been discontinued_ as such. See `Pin Your Packages`_ by Vincent\nDriessen for the original introduction. Since there are still use cases, the\ntool now lives on as a separate package.\n\n\n.. _pip-tools: https://github.com/nvie/pip-tools/\n.. _discontinued: https://github.com/nvie/pip-tools/issues/185\n.. _Pin Your Packages: http://nvie.com/posts/pin-your-packages/\n.. _cram: https://bitheap.org/cram/",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "pip-review lets you smoothly manage all available PyPI updates.",
    "version": "1.3.0",
    "project_urls": {
        "Homepage": "https://github.com/jgonggrijp/pip-review"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f7e8bcb143f21668de2c285ce3d73041ba035b2340fb44bdd95ee04b3e313d09",
                "md5": "0b892bfc7a24d67814a47d981f90ee02",
                "sha256": "886fc48503a6ec99851036f30a6be07ce7e4610d1491786affecb7a364eddeda"
            },
            "downloads": -1,
            "filename": "pip-review-1.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0b892bfc7a24d67814a47d981f90ee02",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7, !=3.0, !=3.1, !=3.2",
            "size": 6644,
            "upload_time": "2022-11-29T16:45:35",
            "upload_time_iso_8601": "2022-11-29T16:45:35.122731Z",
            "url": "https://files.pythonhosted.org/packages/f7/e8/bcb143f21668de2c285ce3d73041ba035b2340fb44bdd95ee04b3e313d09/pip-review-1.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-11-29 16:45:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jgonggrijp",
    "github_project": "pip-review",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "tox": true,
    "lcname": "pip-review"
}
        
Elapsed time: 0.24144s