Sopel

===============================

This slightly cursed version of Sopel is brought to you by the following happy
coincidences. When this release cycle began:

* 6.6.6 was the next patch version number
* Tax Day (in the U.S.) was just a few weeks off — the perfect release date

As it happens, the [v6.6.6 GitHub milestone][ms-666] ended up with 13 closed
issues/PRs in total. We *definitely* didn't try to *plan* any of this. Promise.

[ms-666]: https://github.com/sopel-irc/sopel/milestone/21?closed=1

Module changes
--------------

* Potential denial-of-service via repeated long output in the `.py` and `.calc`
commands was mitigated [[1552][]]
* `admin` module's `.set` command no longer throws an exception if missing
arguments [[1520][]]
* Fixed `admin` module's `.mode` command sending invalid raw line [[1549][]]
* Tweaked output-formatting code in the `meetbot` & `reddit` modules [[1516][]]
* The most visible effect of this is that moderators' names will now appear
green in `reddit`'s output, like on the site, instead of the old brown/purple
* Updated example/test output for `.ip` command [[1523][]]

Core changes
------------

* Flood protection delay is now capped at 2 seconds [[1552][]]
* The flood delay penalty is calculated using the message length before
truncation. Very long command output could thus "hang" the bot for many
minutes at a time, meaning some modules could be used to DoS the bot.
* Sopel 7 will add configuration for flood protection and perhaps reorganize
the logic to reduce silly bugs like this. (See: [1518][], [1559][])
* Fixed a few cases where keyboard interrupt (Control + C) wasn't handled
correctly [[1534][], [1558][]]
* Fixed invalid `MODE` command sent during connection phase [[1544][]]

API changes
-----------

* Fixed a regression in testing modules by running them directly [[1529][]]
* Fixed that `bot` output methods (`say`, `reply`, etc.) would cause errors
during tests if passed certain keyword arguments [[1538][]]

[1516]: https://github.com/sopel-irc/sopel/pull/1516
[1518]: https://github.com/sopel-irc/sopel/pull/1518
[1520]: https://github.com/sopel-irc/sopel/pull/1520
[1523]: https://github.com/sopel-irc/sopel/pull/1523
[1529]: https://github.com/sopel-irc/sopel/pull/1529
[1534]: https://github.com/sopel-irc/sopel/pull/1534
[1538]: https://github.com/sopel-irc/sopel/pull/1538
[1544]: https://github.com/sopel-irc/sopel/pull/1544
[1549]: https://github.com/sopel-irc/sopel/pull/1549
[1552]: https://github.com/sopel-irc/sopel/pull/1552
[1558]: https://github.com/sopel-irc/sopel/pull/1558
[1559]: https://github.com/sopel-irc/sopel/issues/1559

===============================

Module changes
--------------

* Fixed url module not cleaning punctuation when auto-titling [[1515][]]
* Fixed url module's punctuation-cleaning on Python 2 [[1517][]]
* Fixed `.redditor` command with newer `praw` versions (4.0+) [[1506][]]
* Reloading modules now runs their `shutdown()` routines [[1412][]]

[1412]: https://github.com/sopel-irc/sopel/pull/1412
[1506]: https://github.com/sopel-irc/sopel/pull/1506
[1515]: https://github.com/sopel-irc/sopel/pull/1515
[1517]: https://github.com/sopel-irc/sopel/pull/1517

===============================

Module changes
--------------

* Replaced `help` pastebin with `clbin.com`
* `ptpb.pw` shut down due to abuse — see [ptpb/pb246](
https://github.com/ptpb/pb/issues/246) for more
* More news on this front (reducing Sopel's dependence on specific pastebins)
in a future release. Several ideas are under consideration.
* Cleaned up code in `instagram` and `unicode` modules
* Core modules now use `bot.channels` instead of deprecated `bot.privileges`

Core changes
------------

* Privilege tracking now always updates both `bot.channels` & `bot.privileges`,
where before some handlers only updated one or the other
* This *should* have zero effect on behavior, but do report any observed.

===============================

Module changes
--------------

* Fixed loading etymology module on Python 3.3
* Added Unicode support to calc module's `.py` output
* Correctly quote URL parameters in etymology and search modules

Core changes
------------

* Added docstrings to the privilege level constants in `sopel.module`

===============================

Module changes
--------------

* wiktionary tries harder to get a valid result before erroring out

Core changes
------------

* Fixed an inconsistency between interpretations of the `--config` option in
normal operation vs. wizard mode
* Requirement specifiers tightened up to reduce/prevent `pip` trying to install
incompatible dependency versions (`IPython`, `dnspython`)
* SASL token is now split when required according to spec
* Multi-byte Unicode characters are now handled correctly when splitting lines

===============================

Module changes
--------------

* spellcheck's `pyenchant` dependency is no longer required for py3.7+
* This should alleviate a lot of installation problems due to `pyenchant`
being unmaintained. If use of the spellcheck module is desired, the
necessary libraries may be installed manually.