.. pyautoupdate documentation master file, created by
   sphinx-quickstart on Wed May 18 10:03:49 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Pyautoupdate's documentation!
========================================

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

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

Example code using Pyautoupdate can be found in :doc:`quickstart`.

Pyautoupdate is released under the `LGPL 2.1 <https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html>`__.

Contents:

.. toctree::
   :maxdepth: 2

   quickstart
   pyautoupdate
   project
   internal
   contributing

This documentation was built from commit |release| on |today|.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`