Metadata-Version: 2.0
Name: pipdate
Version: 0.2.1
Summary: check for updates on PyPi
Home-page: https://github.com/nschloe/pipdate
Author: Nico Schlömer
Author-email: nico.schloemer@gmail.com
License: License :: OSI Approved :: MIT License
Download-URL: https://pypi.python.org/pypi/pipdate
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: System :: Software Distribution
Requires-Dist: appdirs
Requires-Dist: requests

pipdate
=======

|Build Status| |codecov| |PyPi Version| |GitHub stars|

Small pip update helpers.

::

    sudo -H pipdate
    sudo -H pipdate3

updates *all* your pip{3}-installed packages.

There's a Python interface as well that can be used for upgrade
notifications. Simply do

.. code:: python

    import pipdate
    msg = pipdate.check('matplotlib', '0.4.5')
    print(msg)

This will print

::

    Upgrade to   matplotlib 2.0.0    available! (installed: 0.4.5)

    matplotlib's API changes in this upgrade. Changes to your code may be necessary.

    To upgrade matplotlib with pip, type

       pip install -U matplotlib

    To upgrade _all_ pip-installed packages, use

       pipdate/pipdate3

    To disable these checks, set SecondsBetweenChecks in
    /home/jdoe/.config/pipdate/config.ini

If you guard the check with

.. code:: python

    if pipdate.needs_checking('matplotlib'):
        print(pipdate.check('matplotlib', '0.4.5'))

then it will be performed at most every *k* seconds, where *k* is
specified in the config file ``$HOME/.config/pipdate/config.ini``, e.g.,
once a day

::

    [DEFAULT]
    secondsbetweenchecks = 86400

This can, for example, be used by module authors to notify users of
upgrades of their own modules.

Installation
~~~~~~~~~~~~

pipdate is `available from the Python Package
Index <https://pypi.python.org/pypi/pipdate/>`__, so simply type

::

    pip install pipdate

Testing
~~~~~~~

To run the pipdate unit tests, check out this repository and type

::

    pytest

Distribution
~~~~~~~~~~~~

To create a new release

1. bump the ``__version__`` number,

2. publish to PyPi and GitHub:

   ::

       $ make publish

License
~~~~~~~

pipdate is published under the `MIT
license <https://en.wikipedia.org/wiki/MIT_License>`__.

.. |Build Status| image:: https://travis-ci.org/nschloe/pipdate.svg?branch=master
   :target: https://travis-ci.org/nschloe/pipdate
.. |codecov| image:: https://codecov.io/gh/nschloe/pipdate/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/nschloe/pipdate
.. |PyPi Version| image:: https://img.shields.io/pypi/v/pipdate.svg
   :target: https://pypi.python.org/pypi/pipdate
.. |GitHub stars| image:: https://img.shields.io/github/stars/nschloe/pipdate.svg?style=social&label=Stars&maxAge=2592000
   :target: https://github.com/nschloe/pipdate


