sopel-amputator

Sopel plugin that detects AMP links and finds their canonical forms using AmputatorBot

Installing

Releases are hosted on PyPI, so after installing Sopel, all you need is pip:

$ pip install sopel-amputator

Configuring

The easiest way to configure sopel-amputator is via Sopel's configuration wizard—simply run sopel-plugins configure amputator and enter the values for which it prompts you.

Individual settings are described below.

ignore_domains (list[str])

This is a list of hostnames which sopel-amputator will ignore, even if they match one of the common AMP substrings it looks for. By default it contains a set of ignored domains from the AmputatorBot project.

Setting this value overrides the default, so make sure to also enter any entries that you would like to keep from the default list.

guess_and_check (bool, default true)

The default behavior for AMPutatorBot's "guess and check" feature, which tries to guess canonical URLs when the page doesn't provide one in its HTML.

Behavior can be changed per-channel by chanops and bot admins using the .ampguess command on IRC.

skip_safe_filetypes (bool, default true)

Whether to skip AMP-checking links that look like they point to safe MIME types, e.g. media files.

Changelog

0.3.0

• Guess MIME type of links (by file extension, if present) and skip "safe" types that are probably not wrapped in AMP [#3]
  • Configurable with skip_safe_filetypes config setting.
• Added configuration for AMPutatorBot's "guess and check" function, both a global setting (guess_and_check) and a per-channel override (new ampguess command for chanops and bot admins) [#2]

Under the hood:

• Require stable Sopel 8.x, no more pre-releases
• Updated package metadata & release workflow

0.2.1

• Added Twitter/X domains to default ignore list

0.2.0

Under-the-hood improvements:

• More robust domain matching against ignore list
  • Includes distinct log messages for exact matches vs. subdomain matches
• More granular error handling
• Better error logging
• Migrated package metadata from setup.py+setup.cfg to pyproject.toml

0.1.0

Initial release.

Pending conversion from setup.py+setup.cfg template to newer style package using pyproject.toml—plus some other features on the todo list—but the basics are here:

• Detect likely AMP links
• Call AmputatorBot API for the canonical URL of each suspected AMP link
• Skip links from a configurable list of ignored domains
• Silently fail if no better URL is found