/pyautoupdate

An auto-update API for Python programs. ARCHIVED: The update mechanism here contains no guarantees about code integrity. You may want to look at TUF (The Update Framework) instead.

Primary LanguagePythonGNU Lesser General Public License v2.1LGPL-2.1

Pyautoupdate Logo

Pyautoupdate is an an API library that provides autoupdate functionality for Python programmers.

Travis CI results Codecov Coverage measurements Code Health Join the chat at https://gitter.im/pyautoupdate_chat/Lobby

Pyautoupdate allows end users to easily update their software when the developers release a new version. Developers only need to upload the new version of the application to their server when it is ready. Pyautoupdate provides the functionality to check for updates and automatically download and apply them.

Advantages

  • Pyautoupdate secures its downloads through HTTPS.
  • Updates can be performed either upon prompting or automatically in the background.
  • Pyautoupdate is written in pure Python. No C compiler is necessary for installation, simplifying installation for Windows.
  • Python 2 and 3 are both supported
  • Pyautoupdate also works with pypy and pypy3

Installation

$ pip install pyautoupdate

Documentation

Documentation is available at https://rlee287.github.io/pyautoupdate.

Dependencies

Core Dependencies

  • Python 2.7 or Python 3.4+
  • requests for retrieving updated versions
  • setuptools for archive manipulation and version comparison

Development Dependencies

  • pytest for running the tests
  • coverage.py to measure coverage

Optional Development Dependencies

  • pylint for local code style checks
  • sphinx for building documentation

Contributing

Please see this page for contributing guidelines.

License

Pyautoupdate is licensed under the LGPL 2.1.