|
| 1 | +.. image:: https://travis-ci.org/jgonggrijp/pip-review.svg?branch=master |
| 2 | + :alt: Build status |
| 3 | + :target: https://secure.travis-ci.org/jgonggrijp/pip-review |
| 4 | + |
| 5 | +pip-review |
| 6 | +========== |
| 7 | + |
| 8 | +``pip-review`` checks PyPI and reports available updates. It uses the list of |
| 9 | +currently installed packages to check for updates, it does not use any |
| 10 | +``requirements.txt``. |
| 11 | + |
| 12 | +Example, report-only: |
| 13 | + |
| 14 | +.. code:: console |
| 15 | +
|
| 16 | + $ pip-review |
| 17 | + requests==0.13.4 available (you have 0.13.2) |
| 18 | + redis==2.4.13 available (you have 2.4.9) |
| 19 | + rq==0.3.2 available (you have 0.3.0) |
| 20 | +
|
| 21 | +Example, actually install everything: |
| 22 | + |
| 23 | +.. code:: console |
| 24 | +
|
| 25 | + $ pip-review --auto |
| 26 | + ... <pip install output> |
| 27 | +
|
| 28 | +Example, run interactively, ask to upgrade for each package: |
| 29 | + |
| 30 | +.. code:: console |
| 31 | +
|
| 32 | + $ pip-review --interactive |
| 33 | + requests==0.14.0 available (you have 0.13.2) |
| 34 | + Upgrade now? [Y]es, [N]o, [A]ll, [Q]uit y |
| 35 | + ... |
| 36 | + redis==2.6.2 available (you have 2.4.9) |
| 37 | + Upgrade now? [Y]es, [N]o, [A]ll, [Q]uit n |
| 38 | + rq==0.3.2 available (you have 0.3.0) |
| 39 | + Upgrade now? [Y]es, [N]o, [A]ll, [Q]uit y |
| 40 | + ... |
| 41 | +
|
| 42 | +Up until version 0.3.7, ``pip-review`` would show and install any available |
| 43 | +update including pre-release versions. As of version 0.4, it will only show and |
| 44 | +install release versions by default. To restore the original behaviour, use the |
| 45 | +``--pre`` flag. |
| 46 | + |
| 47 | +Since version 0.5, you can also invoke pip-review as ``python -m pip_review``. **This is the only way to invoke pip-review that enables it to update itself.** |
| 48 | + |
| 49 | + |
| 50 | +Installation |
| 51 | +============ |
| 52 | + |
| 53 | +To install, simply use pip: |
| 54 | + |
| 55 | +.. code:: console |
| 56 | +
|
| 57 | + $ pip install pip-review |
| 58 | +
|
| 59 | +Decide for yourself whether you want to install the tool system-wide, or |
| 60 | +inside a virtual env. Both are supported. |
| 61 | + |
| 62 | + |
| 63 | +Testing |
| 64 | +======= |
| 65 | + |
| 66 | +To test with your active Python version: |
| 67 | + |
| 68 | +.. code:: console |
| 69 | +
|
| 70 | + $ ./run-tests.sh |
| 71 | +
|
| 72 | +To test under all (supported) Python versions: |
| 73 | + |
| 74 | +.. code:: console |
| 75 | +
|
| 76 | + $ tox |
| 77 | +
|
| 78 | +The tests run quite slow, since they actually interact with PyPI, which |
| 79 | +involves downloading packages, etc. So please be patient. |
| 80 | + |
| 81 | + |
| 82 | +Origins |
| 83 | +======= |
| 84 | + |
| 85 | +``pip-review`` was originally part of pip-tools_ but |
| 86 | +has been discontinued_ as such. See `Pin Your Packages`_ by Vincent |
| 87 | +Driessen for the original introduction. Since there are still use cases, the |
| 88 | +tool now lives on as a separate package. |
| 89 | + |
| 90 | + |
| 91 | +.. _pip-tools: https://github.com/nvie/pip-tools/ |
| 92 | +.. _discontinued: https://github.com/nvie/pip-tools/issues/185 |
| 93 | +.. _Pin Your Packages: http://nvie.com/posts/pin-your-packages/ |
| 94 | +.. _cram: https://bitheap.org/cram/ |
0 commit comments