Metadata-Version: 1.1
Name: django-updater
Version: 0.1.6
Summary: Helps you to keep your Django installation up to date
Home-page: https://github.com/jayfk/django-updater
Author: Jannis Gebauer
Author-email: ja.geb@me.com
License: BSD
Description: .. image:: https://djangoupdater.com/static/images/logo.png
            :target: https://djangoupdater.com
        
        ------
        
        .. image:: https://badge.fury.io/py/django-updater.png
            :target: https://pypi.python.org/pypi/django-updater
        .. image:: https://travis-ci.org/jayfk/django-updater.svg?branch=master
            :target: https://travis-ci.org/jayfk/django-updater
        
        Django Updater helps you to keep your Django installation up to date. It warns you when a new security related release comes out and when your Django version hits end of life.
        
        Documentation
        -------------
        
        The full documentation is at https://django-updater.readthedocs.org.
        
        Quickstart
        ----------
        
        Install django-updater::
        
            pip install django-updater
        
        Then, add it to your `INSTALLED_APPS`::
        
            INSTALLED_APPS = (
                ...
                "updater",
            )
        
        And run the migrations with::
        
            python manage.py migrate updater
        
        
        Screenshots
        -----------
        .. image:: https://djangoupdater.com/static/images/security_mail.png
        
        ------
        
        .. image:: https://djangoupdater.com/static/images/update_mail.png
        
        Usage
        --------
        
        In order to check for updates Django Updater has to be called periodically. There are three ways to accomplish that:
        
        - Using the service on djangoupdater.com (not yet implemented)
        - Running a periodic `Celery` task
        - Create a cronjob
        
        With Djangoupdater.com
        ----------------------
        Warning: The service is not live, yet.
        
        Create an account on djangoupdater.com, and copy the token from your dashboard.
        
        To register your site, run
        
            python manage.py register_updater --token=<YOUR_TOKEN>
        
        
        The service will now try to contact your site. If all went well, the command should terminate with
        
            All went well!
        
        Celery
        ------
        
        If you are using `Celery` and have a celery beat daemon running, enable Celery support in your settings with::
        
             from datetime import timedelta
        
             CELERYBEAT_SCHEDULE = {
                 'run-django-updater': {
                     'task': 'updater.tasks.run_check',
                     'schedule': timedelta(days=1),
                 },
             }
        
        
        And you are good to go!
        
        Cronjob
        -------
        
        You can use a cronjob to check for updates once a day.
        
        To set up a cronjob, run::
        
             crontab -e
        
        And then add::
        
             30 2 * * * python /path/to/your/apps/manage.py check_for_updates
        
        
        If you are using a virtual environment, you might need to point to the python executable your virtual environment is using::
        
             30 2 * * * /path/to/virtual/environment/bin/python /path/to/your/apps/manage.py check_for_updates
        
        
        If all this fails, or you want to start the process from a remote host, you can call the remote url.
        
        To do that, run::
        
             python manage.py updater_token
        
        Copy the token and create a cronjob like this::
        
              30 2 * * * curl https://domain.com/updater/run/<YOUR_TOKEN>/
        
        
        
        
        History
        -------
        
        0.1.6 (2015-09-07)
        ++++++++++++++++++
        
        * Added online service registration
        * Fixed minor issues
        
        0.1.5 (2015-08-19)
        ++++++++++++++++++
        
        * Fixed minor issues
        
        0.1.4 (2015-08-19)
        ++++++++++++++++++
        
        * Fixed packaging issue
        
        0.1.3 (2015-08-19)
        ++++++++++++++++++
        
        * Temporarily fixing piprot issue with pytz
        
        0.1.2 (2015-08-19)
        ++++++++++++++++++
        
        * Added package requirements
        
        0.1.1 (2015-08-19)
        ++++++++++++++++++
        
        * Switched to `pip.get_installed_distributions` to get a package list
        * minor documentation tweaks
        
        0.1.0 (2015-08-19)
        ++++++++++++++++++
        
        * First release on PyPI.
        
Keywords: django-updater
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
