update-checker

Name	update-checker JSON
Version	0.18.0 JSON
	download
home_page	https://github.com/bboe/update_checker
Summary	A python module that will check for package updates.
upload_time	2020-08-04 07:08:50
maintainer
docs_url	None
author	Bryce Boe
requires_python
license	Simplified BSD License
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI
coveralls test coverage	No coveralls.

            [![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
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/bboe/update_checker",
    "name": "update-checker",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Bryce Boe",
    "author_email": "bbzbryce@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/5c/0b/1bec4a6cc60d33ce93d11a7bcf1aeffc7ad0aa114986073411be31395c6f/update_checker-0.18.0.tar.gz",
    "platform": "",
    "description": "[![Build Status](https://travis-ci.org/bboe/update_checker.png)](https://travis-ci.org/bboe/update_checker)\n\n# update_checker\n\nA python module that will check for package updates.\n\nOnly whitelisted packages can be checked for updates. Contact update_checker's\nauthor for information on adding a package to the whitelist.\n\n### Installation\n\nThe update_checker module can be installed via:\n\n    pip install update_checker\n\n### Usage\n\nTo simply output when there is a newer version of the `praw` package, you can\nuse the following bit of code:\n\n```python\nfrom update_checker import update_check\nupdate_check('praw', '0.0.1')\n```\n\nIf you need more control, such as performing operations conditionally when\nthere is an update you can use the following approach:\n\n```python\nfrom update_checker import UpdateChecker\nchecker = UpdateChecker()\nresult = checker.check('praw', '0.0.1')\nif result:  # result is None when an update was not found or a failure occured\n   # result is a UpdateResult object that contains the following attributes:\n   # * available_version\n   # * package_name\n   # * running_version\n   # * release_date (is None if the information isn't available)\n   print(result)\n   # Conditionally perform other actions\n```\n\n\n",
    "bugtrack_url": null,
    "license": "Simplified BSD License",
    "summary": "A python module that will check for package updates.",
    "version": "0.18.0",
    "project_urls": {
        "Homepage": "https://github.com/bboe/update_checker"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0cba8dd7fa5f0b1c6a8ac62f8f57f7e794160c1f86f31c6d0fb00f582372a3e4",
                "md5": "c42506f8b1e139fb92199ecfb0db8564",
                "sha256": "cbba64760a36fe2640d80d85306e8fe82b6816659190993b7bdabadee4d4bbfd"
            },
            "downloads": -1,
            "filename": "update_checker-0.18.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c42506f8b1e139fb92199ecfb0db8564",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7008,
            "upload_time": "2020-08-04T07:08:49",
            "upload_time_iso_8601": "2020-08-04T07:08:49.510711Z",
            "url": "https://files.pythonhosted.org/packages/0c/ba/8dd7fa5f0b1c6a8ac62f8f57f7e794160c1f86f31c6d0fb00f582372a3e4/update_checker-0.18.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5c0b1bec4a6cc60d33ce93d11a7bcf1aeffc7ad0aa114986073411be31395c6f",
                "md5": "080504aa36e080fe8c3171fd25d81150",
                "sha256": "6a2d45bb4ac585884a6b03f9eade9161cedd9e8111545141e9aa9058932acb13"
            },
            "downloads": -1,
            "filename": "update_checker-0.18.0.tar.gz",
            "has_sig": false,
            "md5_digest": "080504aa36e080fe8c3171fd25d81150",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6699,
            "upload_time": "2020-08-04T07:08:50",
            "upload_time_iso_8601": "2020-08-04T07:08:50.429516Z",
            "url": "https://files.pythonhosted.org/packages/5c/0b/1bec4a6cc60d33ce93d11a7bcf1aeffc7ad0aa114986073411be31395c6f/update_checker-0.18.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-08-04 07:08:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bboe",
    "github_project": "update_checker",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "lcname": "update-checker"
}