Merge remote-tracking branch 'origin/develop'

Author: awdeorio

.github/workflows/main.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       # Define OS and Python versions to use. 3.x is the latest minor version.
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.x"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.x"]
         os: [ubuntu-latest]
 
     # Sequence of tasks for this job

README.md

@@ -23,7 +23,8 @@ A simple, command line mail merge tool.
 
 ## Quickstart
 ```console
-$ pip install mailmerge
+$ pipx install mailmerge
+$ pipx ensurepath
 $ mailmerge
 ```
 
@@ -32,12 +33,8 @@ $ mailmerge
 ## Install
 System-wide install.
 ```console
-$ pip install mailmerge
-```
-
-System-wide install requiring administrator privileges.  Use this if you get a `Permission denied` error.
-```console
-$ sudo pip install mailmerge
+$ pipx install mailmerge
+$ pipx ensurepath
 ```
 
 Fedora package install.
@@ -208,6 +205,7 @@ This example will send progress reports to students.  The template uses more of
 TO: {{email}}
 SUBJECT: EECS 280 Mid-semester Progress Report
 FROM: My Self <[email protected]>
+REPLY-TO: My Reply Self <[email protected]>
 
 Dear {{name}},
 

mailmerge/__main__.py

@@ -73,7 +73,9 @@ def main(sample, dry_run, limit, no_limit, resume,
     """
     # We need an argument for each command line option.  That also means a lot
     # of local variables.
-    # pylint: disable=too-many-arguments, too-many-locals
+    # pylint: disable=too-many-arguments
+    # pylint: disable=too-many-positional-arguments
+    # pylint: disable=too-many-locals
 
     # Convert paths from string to Path objects
     # https://github.com/pallets/click/issues/405
@@ -315,8 +317,7 @@ def read_csv_database(database_path):
         csvdialect.strict = True
         reader = csv.DictReader(database_file, dialect=csvdialect)
         try:
-            for row in reader:
-                yield row
+            yield from reader
         except csv.Error as err:
             raise exceptions.MailmergeError(
                 f"{database_path}:{reader.line_num}: {err}"

pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=64.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mailmerge"
+version = "2.2.4"
+description = "A simple, command line mail merge tool"
+keywords = ["mail merge", "mailmerge", "email"]
+authors = [{ email = "[email protected]" }, { name = "Andrew DeOrio" }]
+license = {file = "LICENSE"}
+readme = "README.md"
+requires-python = ">=3.6"
+dependencies = [
+    "click",
+    "jinja2",
+    "markdown",
+    "html5lib"
+]
+
+[project.optional-dependencies]
+dev = [
+    "twine",
+    "tox",
+]
+test = [
+    "check-manifest",
+    "freezegun",
+    "pycodestyle",
+    "pydocstyle",
+    "pylint",
+    "pytest",
+    "pytest-cov",
+    "pytest-mock",
+]
+
+[project.scripts]
+mailmerge = "mailmerge.__main__:main"
+
+[project.urls]
+homepage = "https://github.com/awdeorio/mailmerge/"
+
+[tool.setuptools]
+packages = ["mailmerge"]

setup.py

@@ -1,53 +1,5 @@
-"""Mailmerge build and install configuration."""
-from pathlib import Path
-import setuptools
+"""Support legacy tools."""
 
+from setuptools import setup
 
-# Read the contents of README file
-PROJECT_DIR = Path(__file__).parent
-README = PROJECT_DIR/"README.md"
-LONG_DESCRIPTION = README.open(encoding="utf8").read()
-
-
-setuptools.setup(
-    name="mailmerge",
-    description="A simple, command line mail merge tool",
-    long_description=LONG_DESCRIPTION,
-    long_description_content_type="text/markdown",
-    version="2.2.3",
-    author="Andrew DeOrio",
-    author_email="[email protected]",
-    url="https://github.com/awdeorio/mailmerge/",
-    license="MIT",
-    packages=["mailmerge"],
-    keywords=["mail merge", "mailmerge", "email"],
-    install_requires=[
-        "click",
-        "jinja2",
-        "markdown",
-        "html5lib"
-    ],
-    extras_require={
-        "dev": [
-            "pdbpp",
-            "twine",
-            "tox",
-        ],
-        "test": [
-            "check-manifest",
-            "freezegun",
-            "pycodestyle",
-            "pydocstyle",
-            "pylint",
-            "pytest",
-            "pytest-cov",
-            "pytest-mock",
-        ],
-    },
-    python_requires='>=3.6',
-    entry_points={
-        "console_scripts": [
-            "mailmerge = mailmerge.__main__:main",
-        ]
-    },
-)
+setup()

tox.ini

@@ -1,16 +1,16 @@
 # Local host configuration with one Python 3 version
 [tox]
-envlist = py36, py37, py38, py39, py310
+envlist = py38, py39, py310, py311, py312
 
 # GitHub Actions configuration with multiple Python versions
 # https://github.com/ymyzk/tox-gh-actions#tox-gh-actions-configuration
 [gh-actions]
 python =
-  3.6: py36
-  3.7: py37
   3.8: py38
   3.9: py39
   3.10: py310
+  3.11: py311
+  3.12: py312
 
 # Run unit tests
 # HACK: Pydocstyle fails to find tests.  Invoke a shell to use a glob.