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:**

- support for local caches (index-url) from `~/.pip/pip.conf` (ex: devpi)
- 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


(Notes for me):
Release new version:

- increment version in :code:`pip_upgrader/__init__.py`
- commit everything, push on master, then
::

git tag v`pip-upgrade --version` && git push --tags

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.3.5.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.3.5-py2.py3-none-any.whl (14.0 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for pip_upgrader-1.3.5.tar.gz
Algorithm Hash digest
SHA256 70e10ec9f67f77627d86c8177b8817d7db8925100040a43b18601cceb6bed3d8
MD5 f1c329fdcc5f3129dd4b2306c6615ffd
BLAKE2b-256 24f24f6262ccd26692cda30e41aa40f44d338fd7f6744a699260ae62692bd99f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pip_upgrader-1.3.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a134d7fb80f0b848ee774989b7f41ca8fe59922c9e383d77c0e166fee0ec929b
MD5 ab83e627298a0a16f4ade8b0aa4024c2
BLAKE2b-256 62f74d9609f1b4b98d7f4e7edaabc57e0d812985c198f8c90c45c46197871067

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