Skip to content

Commit

Permalink
apt_info.py: use docstring for module documentation (#211)
Browse files Browse the repository at this point in the history
Signed-off-by: Frank Sachsenheim <funkyfuture@users.noreply.github.com>
  • Loading branch information
funkyfuture committed May 7, 2024
1 parent 1cb6223 commit 4ed063f
Showing 1 changed file with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions apt_info.py
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
#!/usr/bin/env python3
#
# Description: Expose metrics from apt. This is inspired by and
# intended to be a replacement for the original apt.sh.
#
# This script deliberately does *not* update the apt cache. You need
# something else to run `apt update` regularly for the metrics to be
# up to date. This can be done in numerous ways, but the canonical way
# is to use the normal `APT::Periodic::Update-Package-Lists`
# setting.
#
# This, for example, will enable a nightly job that runs `apt update`:
#
# echo 'APT::Periodic::Update-Package-Lists "1";' > /etc/apt/apt.conf.d/99_auto_apt_update.conf
#
# See /usr/lib/apt/apt.systemd.daily for details.
#
# Dependencies: python3-apt, python3-prometheus-client
#
# Authors: Kyle Fazzari <kyrofa@ubuntu.com>
# Daniel Swarbrick <dswarbrick@debian.org>

"""
Description: Expose metrics from apt. This is inspired by and
intended to be a replacement for the original apt.sh.
This script deliberately does *not* update the apt cache. You need
something else to run `apt update` regularly for the metrics to be
up to date. This can be done in numerous ways, but the canonical way
is to use the normal `APT::Periodic::Update-Package-Lists`
setting.
This, for example, will enable a nightly job that runs `apt update`:
echo 'APT::Periodic::Update-Package-Lists "1";' > /etc/apt/apt.conf.d/99_auto_apt_update.conf
See /usr/lib/apt/apt.systemd.daily for details.
Dependencies: python3-apt, python3-prometheus-client
Authors: Kyle Fazzari <kyrofa@ubuntu.com>
Daniel Swarbrick <dswarbrick@debian.org>
"""

import apt
import apt_pkg
Expand Down

0 comments on commit 4ed063f

Please sign in to comment.