GitXplorerGitXplorer
b

update_checker

public
28 stars
5 forks
3 issues

Commits

List of commits on branch main.
Verified
2f3b1db5ae816cb3d9c7ad65c3d3a955e4b8197d

Delete FUNDING.yml

bbboe committed 4 years ago
Verified
f9c9bb9118fcd70445f1416c00cd1e14905245e3

Create FUNDING.yml

bbboe committed 4 years ago
Verified
dc5f9ac695e1046ac57695dd6959f270956ae612

Merge pull request #16 from bboe/pypi

bbboe committed 4 years ago
Verified
bb0e0081528069d1d57c192db0cf8211b25ff630

Update for version 0.18

bbboe committed 4 years ago
Verified
b293952ae249bcc5c786711f8285211c54de58a2

Set long_description_content_type to markdown

bbboe committed 5 years ago
Verified
7bd78b9da1c0e8dc3ff7f599ffadbde0528a6202

Merge pull request #14 from PythonCoderAS/patch-1

bbboe committed 5 years ago

README

The README file for this repository.

Build Status

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:

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:

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