A python module that will check for package updates.
Project description
[![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.
### 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 `update_checker` package,
you can use the following bit of code:
```python
from update_checker import update_check
update_check('update_checker', '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('update_checker', '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
```
# update_checker
A python module that will check for package updates.
### 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 `update_checker` package,
you can use the following bit of code:
```python
from update_checker import update_check
update_check('update_checker', '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('update_checker', '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
```
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
update_checker-0.8.tar.gz
(4.7 kB
view hashes)
Built Distribution
Close
Hashes for update_checker-0.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7830165cb71a338b7a33c9b26943b08643ff1a58de7f64a36aad4bb123a587dd |
|
MD5 | dea6d72851921a9846cf54ab97de2823 |
|
BLAKE2b-256 | 35f8fae244739cbe2ec5f73693e21d5e2e9eef1ad463a28dccf56dc24de5f755 |