sopel-spongemock

Sopel plugin to generate "Spongemock" text (based on that SpongeBob meme)

Requirements

Basic usage: Only Sopel itself.

With configurable output: Additionally requires the spongemock PyPI package.

More robust Unicode detection: Additionally requires the unicodedata2 PyPI package.

Installation

Basic

pip install sopel-spongemock

Configurable

pip install sopel-spongemock[lib]

Robust

pip install sopel-spongemock[ud2]

Note: It is possible to install both lib and ud2 extras at once, but doing so serves no purpose; the spongemock package does not make use of unicodedata or unicodedata2.

Configuration

If installed with the lib extra, use the following template in Sopel's configuration file to set options for spongemock's output:

[spongemock]
diversity_bias = 0.6
always_start_lower = False

The diversity_bias option controls the chance of switching cases for each letter in the output. 0.0 represents a perfectly random, 50/50 chance. Higher values increase the likelihood of switching as more consecutive letters are output with the same case. At 1.0, it's guaranteed that the case will switch for every letter.

Values outside the range of [0.0, 1.0] will cause errors.

Feel free to experiment with intermediate values to find what "looks right" for your own interpretation of the mocking-text meme.

The always_start_lower option will output text.swapcase() if the first letter of the output is capitalized. (While the built-in mocker always starts with lowercase, the external library sets case of the first letter randomly.)

Note: Options in this configuration section have no effect if the plugin is installed without the lib extra.

Usage

.spongemock <nick>|<text>

or

.smock <nick>|<text>

If a single word is passed, the command will first check if that nick has said anything in the channel recently, and will mock their last message if so.

Any input that does not match a known user's nick will be mocked directly.

Examples

<dgw> .smock Free speech!
<Sopel> fREe SpEEcH

<dgw> I'm something of a Pythonista myself
<ziro> .smock dgw
<Sopel> i'M soMeThiNg oF a pYtHOnIsTA mySElf

Changelog

1.2.0

Changed:

• Modernized package metadata and automated releases (#12, #13)
• Require Python 3.8+ (#12)
• Require Sopel 8.0+ (#12)

Environments running Sopel 7.1 and/or older Python can continue to use sopel-spongemock 1.1.3; there are no functional changes in this release.

1.1.3

Changed:

• Take advantage of Sopel 8 features if available (#10)
• Prune old nick's line after nick-change (#11)

1.1.2

Fixed:

• Output canonical nick instead of copying .smock <nick>'s input (#8 by @dgw)
• .smock <nick> didn't casemap correctly (#9 by @dgw)

1.1.1

Fixed:

• TypeError when attempting to .smock by nick (#7 by @SnoopJ)
• Documentation of optional support for unicodedata2 library

Changed:

• Replaced deprecated module decorators with their plugin counterparts (future-proofing this plugin for Sopel 8, Sopel 9, and beyond)

1.1.0

Added:

• Support for using spongemock external library
• Support for unicodedata2 when present
• Plugin configuration options (effective only when external library is in use)

Changed:

• Built-in mocking function is now smarter about only trying to change the case of characters when it's possible to do so
• Minimum supported Sopel version raised from 7.0 to 7.1

1.0.0

First official release, converted from single .py file to package.