aa-package-monitor 1.0.0b1

An app that helps keep track of installed packages and outstanding updates for Alliance Auth

Package Monitor

An app for keeping track of installed packages and outstanding updates with Alliance Auth.

Contents

• Overview
• Screenshots
• Installation
• User Guide
• Settings
• Permissions
• Management Commands
• Change Log

Overview

Package Monitor is an app for Alliance Auth that helps you keep your installation up-to-date. It shows you all installed distributions packages and will automatically notify you, when there are updates available.

Features:

• Shows list of installed distributions packages with related Django apps (if any)
• Identifies new valid releases for installed packages on PyPI
• Notifies user which installed packages are outdated and should be updated
• Shows the number of outdated packages as badge in the sidebar
• Takes into account the requirements of all installed packages and the current Python version when recommending updates
• Option to add distribution pages to the monitor which are not related to Django apps
• Option to show all known distribution packages (as opposed to only the ones that belong to installed Django apps)
• Copy the respective command for a package update to your clipboard directly from the package list

Screenshot

Installation

Step 1 - Check Preconditions

Please make sure you meet all preconditions before proceeding:

• Package Monitor is a plugin for Alliance Auth. If you don't have Alliance Auth running already, please install it first before proceeding. (see the official AA installation guide for details)

Step 2 - Install app

Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PYPI:

pip install aa-package-monitor

Step 3 - Configure settings

• Add 'package_monitor' to INSTALLED_APPS

• Add the following lines to your local.py to enable checking for updates:

  CELERYBEAT_SCHEDULE['package_monitor_update_distributions'] = {
      'task': 'package_monitor.tasks.update_distributions',
      'schedule': crontab(minute='*/60'),
  }
  

• Optional: Add additional settings if you want to change any defaults. See Settings for the full list.

Step 4 - Finalize installation

Run migrations & copy static files

python manage.py migrate
python manage.py collectstatic

Restart your supervisor services for Auth

Step 5 - Initial data load

Last, but not least perform an initial data load of all distribution packages by running the following command:

python manage.py package_monitor_refresh

User Guide

This section explains how to use the app.

Terminology

To avoid any confusion here are definitions some important terms:

• App: A Django application, always part of a distribution package
• Distribution package: A Python package that can be installed via pip or setuptools. Distribution packages can contain several apps.

Operation modes

You can run Package Monitor in one of two modes:

• A. Keep apps and selected distribution packages updated only
• B. Keep everything updated

In mode A we will monitor only those distribution packages that contain actually installed Django apps. In this mode you will be informed if there an update to any of your apps. In addition you can add some other distributions to the monitor, that you like to watch, for example you might want to add celery.

In mode B we will monitor all known distribution packages. This mode will inform you about updates to any of your distribution packages and will help you keep all of them up-to-date.

Latest version

The app will automatically determine a latest version for a distribution package from PyPI. Note that this can differ from the latest version shown on PyPI, because of additional considerations:

First, it will take into account all requirements of the other known distribution packages. For example if the app Alliance Auth has the requirement "Django<3", the it will only show Django 2.x as latest, since Django 3.x would not be compatible with Alliance Auth.

Second, it will ignore pre-releases and only show stable releases. The only exception is if the current package also is a pre release. For example Black may only exist as beta release, therefore the app will also suggest newer beta releases.

Settings

Here is a list of available settings for this app. They can be configured by adding them to your AA settings file (local.py).

Note that all settings are optional and the app will use the documented default settings if they are not used.

Name	Description	Default
PACKAGE_MONITOR_INCLUDE_PACKAGES	Names of additional distribution packages to be monitored, e.g. ["celery", "redis]	None
PACKAGE_MONITOR_SHOW_ALL_PACKAGES	Whether to show all distribution packages, as opposed to only showing packages that contain Django apps	False

Permissions

This is an overview of all permissions used by this app. Note that all permissions are in the "general" section.

Name	Purpose	Code
Can access this app and view	User can access the app and also request updates to the list of distribution packages	general.basic_access

Management Commands

The following management commands are included in this app:

Command	Description
package_monitor_refresh	Refreshes all data about distribution packages. This command does functionally the same as the hourly update and is helpful to use after you have completed updating outdated packages to quickly see the result of your actions on the website.