Skip to main content

An interactive pip requirements upgrader. It also updates the version in your requirements.txt file.

Project description

pip-upgrader
=========
.. image:: https://travis-ci.org/simion/pip-upgrader.svg?branch=master
:target: https://travis-ci.org/simion/pip-upgrader
.. image:: https://coveralls.io/repos/github/simion/pip-upgrader/badge.svg?branch=master
:target: https://coveralls.io/github/simion/pip-upgrader?branch=master


An interactive pip requirements upgrader. Because upgrading requirements, package by package, is a pain in the ass.
It also updates the version in your requirements.txt file.


Purpose
-------

This cli tools helps you interactively(or not) upgrade packages from requirements file,
and also **update the pinned version from requirements file(s)**.

If no requirements are given, the command **attempts to detect the requirements file(s)** in the current directory.

Quick preview:

.. image:: https://raw.githubusercontent.com/simion/pip-upgrader/master/demo.gif

Installation
------------

::

pip install pip-upgrader

Usage
-----
**Activate your virtualenv** (important, because it will also install the new versions of upgraded packages in current virtualenv)

**CD into your project.**
Then:
::

$ pip-upgrade

Arguments:
::

requirements_file(s) The requirement FILE, or WILDCARD PATH to multiple files. (positional arguments)
--prerelease Include prerelease versions for upgrade, when querying pypi repositories.
-p <package> Pre-choose which packages tp upgrade. Skips any prompt.
--dry-run Simulates the upgrade, but does not execute the actual upgrade.
--skip-package-installation Only upgrade the version in requirements files, don't install the new package.
--skip-virtualenv-check Disable virtualenv check. Allows installing the new packages outside the virtualenv.
--use-default-index Skip searching for custom index-url in pip configuration file(s).

Examples:

::

pip-upgrade # auto discovers requirements file. Prompts for selecting upgrades
pip-upgrade requirements.txt
pip-upgrade requirements/dev.txt requirements/production.txt

# skip prompt and manually choose some/all packages for upgrade
pip-upgrade requirements.txt -p django -p celery
pip-upgrade requirements.txt -p all

# include pre-release versions
pip-upgrade --prerelease


Final notes
-----------
If you encounter any bugs, please open an issue and it will be magically resolved :)

**TODO:**

- implement some sort of dependency detection, and nested display. Useful for requirements generated with pip freeze.
- support for :code:`package>=0.1.0` (only works for :code:`package==0.1.0`)


Have fun! :)

Contributing
------------
Clone the repository, create a virtualenv, then run:
::

pip install -e .[test]
py.test

This command will :

- run tests
- print coverage report
- print pep8 errors

For detailed coverage report, after *py.test* run
::

coverage html && open htmlcov/index.html

**Testing against all python version**
Make sure you have python 2.7, 3.5, 3.6 installed (maybe use pyenv). Then:
::

pip install tox

tox

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pip_upgrader-1.4.0.tar.gz (5.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pip_upgrader-1.4.0-py2.py3-none-any.whl (14.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pip_upgrader-1.4.0.tar.gz.

File metadata

  • Download URL: pip_upgrader-1.4.0.tar.gz
  • Upload date:
  • Size: 5.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pip_upgrader-1.4.0.tar.gz
Algorithm Hash digest
SHA256 92bde23ef8f307e7c1595130f58b2e1840a62690bd9e82c1e8a82d5516de6921
MD5 1b401ef39ba8df949427fc422518bd55
BLAKE2b-256 a2aabbec7df19a29c2d3ded829c136116e50d0c2f86287b24fb4162aa9521db8

See more details on using hashes here.

File details

Details for the file pip_upgrader-1.4.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pip_upgrader-1.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 158ef4df3cf36a25d9f1d18a079bd86d78515be191d09d63132738e52f6001f9
MD5 ab7d4df56b1dc98dd00926793f227511
BLAKE2b-256 904155fd034f13780c9ced6220e23a8b286b8577e77c323cfc7502c39d210525

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page