https://github.com/bboe/update_checker

A python module that will check for package updates.
https://github.com/bboe/update_checker

Last synced: about 16 hours ago
JSON representation

A python module that will check for package updates.

• Host: GitHub
• URL: https://github.com/bboe/update_checker
• Owner: bboe
• License: bsd-2-clause
• Created: 2012-11-04T01:14:10.000Z (about 12 years ago)
• Default Branch: main
• Last Pushed: 2021-07-17T06:44:53.000Z (over 3 years ago)
• Last Synced: 2024-12-13T17:49:58.444Z (14 days ago)
• Language: Python
• Size: 44.9 KB
• Stars: 28
• Watchers: 7
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/bboe/update_checker.png)](https://travis-ci.org/bboe/update_checker)

# update_checker

A python module that will check for package updates.

Only whitelisted packages can be checked for updates. Contact update_checker's

author for information on adding a package to the whitelist.

### Installation

The update_checker module can be installed via:

    pip install update_checker

### Usage

To simply output when there is a newer version of the `praw` package, you can

use the following bit of code:

```python

from update_checker import update_check

update_check('praw', '0.0.1')

```

If you need more control, such as performing operations conditionally when

there is an update you can use the following approach:

```python

from update_checker import UpdateChecker

checker = UpdateChecker()

result = checker.check('praw', '0.0.1')

if result:  # result is None when an update was not found or a failure occured

   # result is a UpdateResult object that contains the following attributes:

   # * available_version

   # * package_name

   # * running_version

   # * release_date (is None if the information isn't available)

   print(result)

   # Conditionally perform other actions

```