Modernize the heck out of things

* `pyproject.toml` packaging * Entry-point plugin style; no more `sopel_modules` namespace * Compatibility with Sopel 8 * Drop Python 2 and EOL 3.x releases; minimum now py3.8 * Drop Sopel 7.0 (but keep 7.1 for now, except on old Pythons) * Improved documentation, metadata, etc. Closes #2 🥳
sopel-irc · Jun 20, 2024 · 814b8d2 · 814b8d2
1 parent 478f998
commit 814b8d2
Show file tree

Hide file tree

Showing 12 changed files with 116 additions and 92 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,8 +1,6 @@
 include NEWS
 include COPYING
 include README.md
-include *requirements.txt
 
-recursive-include tests *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
diff --git a/NEWS b/NEWS
@@ -1,5 +1,24 @@
-Changes between 0.1.0 and 0.2.0
-===============================
-
-Changed:
-* Updated compatibility for Sopel 7
+## Changelog
+
+### 0.3.0
+
+First release as `sopel-inclusivity`, replacing `sopel_modules.inclusivity`.
+
+Changed:
+* Updated compatibility for Sopel 8
+* Minimum Sopel version is now 7.1
+* Use newer `search` rule type, instead of bookending pattern with `.*`
+
+Meta:
+* Packaging converted to `pyproject.toml` and modernized
+  * Package name has changed: `sopel_modules.inclusivity` → `sopel-inclusivity`
+* Author & Maintainer metadata corrected to credit embolalia as the creator
+
+### 0.2.0
+
+Changed:
+* Updated compatibility for Sopel 7
+
+### 0.1.0
+
+Initial release of `sopel_modules.inclusivity`.
diff --git a/README.md b/README.md
@@ -1,8 +1,25 @@
 # sopel-inclusivity
 
-Sopel Inclusive Language suggests better wordings when people don't use
-inclusive language. It's inspired by [this blog
-post](https://18f.gsa.gov/2016/01/12/hacking-inclusion-by-customizing-a-slack-bot/)
-from 18F, who've added a similar feature to their Slack rooms. It only deals
-with use of the word "guys" for now, but if there is any other language it
-could cover, PRs are welcome.
+Have your Sopel bot suggest more inclusive language
+
+## Installing
+
+Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:
+
+```shell
+$ pip install sopel-inclusivity
+```
+
+### Requirements
+
+The `sopel-inclusivity` plugin is compatible with Sopel 7.1 or higher, but your
+bot must run on Python 3.8 or higher; legacy Python versions are not supported.
+
+## Functionality
+
+`sopel-inclusivity` suggests better wordings when people don't use inclusive
+language in chat. It's inspired by [this blog post][18f-post] from 18F, who
+added a similar feature to their Slack rooms. It only deals with use of the word
+"guys" for now, but PRs are welcome to add coverage of more vocabulary.
+
+[18f-post]: https://18f.gsa.gov/2016/01/12/hacking-inclusion-by-customizing-a-slack-bot/
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,62 @@
+[build-system]
+requires = ["setuptools>=63.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+platforms = ["Linux x86, x86-64"]
+
+[tool.setuptools.packages.find]
+include = ["sopel_inclusivity", "sopel_inclusivity.*"]
+namespaces = false
+
+[tool.setuptools.dynamic]
+readme = { file=["README.md", "NEWS"], content-type="text/markdown" }
+
+[project]
+name = "sopel-inclusivity"
+version = "0.3.0.dev0"
+description = "Have your Sopel bot suggest more inclusive language"
+
+authors = [
+  { name="Elsie Powell" },
+]
+
+maintainers = [
+  { name="dgw", email="[email protected]" },
+]
+
+license = { text="EFL-2.0" }
+dynamic = ["readme"]
+
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Intended Audience :: System Administrators",
+  "License :: Eiffel Forum License (EFL)",
+  "License :: OSI Approved :: Eiffel Forum License",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Communications :: Chat :: Internet Relay Chat",
+]
+keywords = [
+  "sopel",
+  "plugin",
+  "bot",
+  "irc",
+]
+
+requires-python = ">=3.8, <4"
+dependencies = [
+  "sopel>=7.1",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/sopel-irc/sopel-inclusivity"
+"Bug Tracker" = "https://github.com/sopel-irc/sopel-inclusivity/issues"
+
+[project.entry-points."sopel.plugins"]
+"inclusivity" = "sopel_inclusivity.plugin"
diff --git a/requirements.txt b/requirements.txt
diff --git a/setup.py b/setup.py
diff --git a/dev-requirements.txt → sopel_inclusivity/__init__.py b/dev-requirements.txt → sopel_inclusivity/__init__.py
diff --git a/sopel_modules/inclusivity/inclusivity.py → sopel_inclusivity/plugin.py b/sopel_modules/inclusivity/inclusivity.py → sopel_inclusivity/plugin.py
@@ -1,10 +1,12 @@
-# coding=utf-8
+"""sopel-inclusivity
 
-from __future__ import unicode_literals, absolute_import, division, print_function
+Inclusive language plugin for Sopel IRC bots
+"""
+from __future__ import annotations
 
 import random
 
-from sopel import module
+from sopel import plugin
 
 
 # Works for generic "hi, guys", but maybe not "you (specific group of) guys"
@@ -14,11 +16,11 @@
 yall = ["y'all", 'you all', 'you folks']
 
 
-@module.rule('(hey|hi|yo|hello|howdy|um|er|oh)[,.?!:;]? guys')
+@plugin.rule('(hey|hi|yo|hello|howdy|um|er|oh)[,.?!:;]? guys')
 def hi_guys(bot, trigger):
     bot.reply('Did you mean {}?'.format(random.choice(greet)))
 
 
-@module.rule('.*you guys.*')
+@plugin.search('you guys')
 def you_guys(bot, trigger):
     bot.reply('Did you mean {}?'.format(random.choice(yall)))
diff --git a/sopel_modules/__init__.py b/sopel_modules/__init__.py
diff --git a/sopel_modules/inclusivity/__init__.py b/sopel_modules/inclusivity/__init__.py
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/test_inclusivity.py b/tests/test_inclusivity.py