pelican-linkclass 2.1.4__tar.gz → 2.1.6__tar.gz

{pelican_linkclass-2.1.4 → pelican_linkclass-2.1.6}/CHANGELOG.md

@@ -1,6 +1,16 @@
 CHANGELOG
 =========
 
+2.1.6 - 2025-11-11
+------------------
+
+This is a maintenance release. For clarity's sake, the wording in the `README.md` documentation file has been improved.
+
+2.1.5 - 2025-01-20
+------------------
+
+This is a maintenance release. No user-visible changes have been made. This release tests the new system to keep alignment with plugin template via Cruft.
+
 2.1.4 - 2024-04-14
 ------------------
 

{pelican_linkclass-2.1.4 → pelican_linkclass-2.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pelican-linkclass
-Version: 2.1.4
+Version: 2.1.6
 Summary: Pelican plugin to set anchor tag's class attribute to differentiate between internal and external links
 Keywords: pelican,plugin,link class
 Author-Email: =?utf-8?q?Rafael_Laboissi=C3=A8re?= <rafael@laboissiere.net>
@@ -10,24 +10,25 @@ Classifier: Environment :: Console
 Classifier: Framework :: Pelican
 Classifier: Framework :: Pelican :: Plugins
 Classifier: Intended Audience :: End Users/Desktop
-Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Project-URL: Homepage, https://github.com/pelican-plugins/linkclass
-Project-URL: Issue tracker, https://github.com/pelican-plugins/linkclass/issues
+Project-URL: Issue Tracker, https://github.com/pelican-plugins/linkclass/issues
+Project-URL: Changelog, https://github.com/pelican-plugins/linkclass/blob/main/CHANGELOG.md
 Project-URL: Funding, https://donate.getpelican.com/
-Requires-Python: <4.0,>=3.8.1
+Requires-Python: >=3.10
 Requires-Dist: pelican>=4.5
 Requires-Dist: py3dns>=3.2
-Requires-Dist: markdown>=3.4; extra == "markdown"
 Provides-Extra: markdown
+Requires-Dist: markdown>=3.4; extra == "markdown"
 Description-Content-Type: text/markdown
 
 Link Class: A Plugin for Pelican
@@ -35,55 +36,50 @@ Link Class: A Plugin for Pelican
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/pelican-plugins/linkclass/main.yml?branch=main)](https://github.com/pelican-plugins/linkclass/actions)
 [![PyPI Version](https://img.shields.io/pypi/v/pelican-linkclass)](https://pypi.org/project/pelican-linkclass/)
-![License](https://img.shields.io/pypi/l/pelican-linkclass?color=blue)
+[![Downloads](https://img.shields.io/pypi/dm/pelican-linkclass)](https://pypi.org/project/pelican-linkclass/)
+[![License](https://img.shields.io/pypi/l/pelican-linkclass?color=blue)](https://www.gnu.org/licenses/agpl-3.0.en.html)
+
+This Pelican plugin lets you to set the class attribute of `<a>` elements (generated in Markdown by `[ext](link)`), depending on whether the link is external (i.e., starts with `http://` or `https://`) or internal to the Pelican-generated site.
 
-This Pelican plugin allows you to set the class attribute of `<a>` elements
-(generated in Markdown by `[ext](link)`) according to whether the link is
-external (i.e., starts with `http://` or `https://`) or internal to the
-Pelican-generated site.
+Currently, this plugin only works with Markdown. It has been tested with version 3.0+ of the Python-Markdown module and may not work with earlier versions.
 
-For now, this plugin only works with Markdown. It has been tested with version
-3.0+ of the Python-Markdown module and may not work with previous versions.
 
 Installation
 ------------
 
-This plugin [is available as a package](https://pypi.org/project/pelican-linkclass/)
-at PyPI and can be installed via:
+This plugin [is available as a package](https://pypi.org/project/pelican-linkclass/) at PyPI and can be installed via:
 
 ```
 python -m pip install pelican-linkclass
 ```
 
+As long as there is no `PLUGINS` setting in the Pelican settings file, the newly installed plugin should be detected and enabled automatically. Otherwise, you must add `linkclass` to your existing `PLUGINS` list. For more information, please refer to the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.
+
+
 Configuration
 -------------
 
-In order to avoid clashes with already-defined classes in the user CSS
-style sheets, it is possible to specify the name of the classes that will
-be used. They can be specified in the Pelican setting file with the
-`LINKCLASS` variable, which must be defined as a list of tuples, like this:
+To avoid clashing with classes already defined in user CSS style sheets, it is possible to specify the names of the classes that will be used. This can be done in the Pelican settings file by defining the `LINKCLASS` variable as a list of tuples, such as in this example:
 
 ```python
 'LINKCLASS' = (('EXTERNAL_CLASS', 'name-of-the-class-for-external-links'),
                ('INTERNAL_CLASS', 'name-of-the-class-for-internal-links'))
 ```
 
-The default values for `EXTERNAL_CLASS` and `INTERNAL_CLASS` are,
-respectively, `'external'` and `'internal'`.
+The default values for `EXTERNAL_CLASS` and `INTERNAL_CLASS` are, respectively, `'external'` and `'internal'`.
+
 
 Styling Hyperlinks
 ------------------
 
-One of the possible uses of this plugins is for styling. Suppose that we
-have the following Markdown content in your article:
+One possible use of this plugin is for styling. Suppose that we have the following Markdown content in your article:
 
 ```markdown
 This is an [internal](internal) link and this is an
 [external](http://external.com) link.
 ```
 
-If the default configuration variable values are used, then one possible
-CSS setting could be:
+Using the default configuration variable values, a possible CSS setting could be:
 
 ```css
 a.external:before {
@@ -92,16 +88,13 @@ a.external:before {
 }
 ```
 
-(The file `external-link.png` is also distributed with this plugin. To use it,
-copy it to the appropriate place in your web site source tree, for instance
-in `theme/static/images/`.)
+(The `external-link.png` file is also distributed with this plugin. To use it, copy it to the appropriate location in your website's source tree, for instance in the `theme/static/images/` directory.)
 
-Then, the result will look like the following:
+The result will then look like this:
 
 ![figure](https://github.com/pelican-plugins/linkclass/raw/main/linkclass-example.png)
 
-Note that this plugin also works with reference-style links, as in the
-following example:
+Note that this plugin also works with reference-style links, as in the following example:
 
 ```markdown
 This is an [internal][internal] link and this is an
@@ -111,6 +104,7 @@ This is an [internal][internal] link and this is an
  [external]: http://external.com
 ```
 
+
 Contributing
 ------------
 
@@ -121,6 +115,7 @@ To start contributing to this plugin, review the [Contributing to Pelican][] doc
 [existing issues]: https://github.com/pelican-plugins/linkclass/issues
 [Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html
 
+
 Acknowledgments
 ---------------
 
@@ -132,10 +127,12 @@ Many thanks to [Yuliya Bagriy][] for setting up the package for [PyPI][], to [Lu
 [pytest]: https://pytest.org/
 [Justin Mayer]: https://github.com/justinmayer
 
+
 Author
 ------
 
-Copyright © 2015, 2017, 2019, 2021-2023 Rafael Laboissière (<rafael@laboissiere.net>)
+Copyright © 2015, 2017, 2019, 2021-2023, 2025 Rafael Laboissière (<rafael@laboissiere.net>)
+
 
 License
 -------

{pelican_linkclass-2.1.4 → pelican_linkclass-2.1.6}/README.md

@@ -3,55 +3,50 @@ Link Class: A Plugin for Pelican
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/pelican-plugins/linkclass/main.yml?branch=main)](https://github.com/pelican-plugins/linkclass/actions)
 [![PyPI Version](https://img.shields.io/pypi/v/pelican-linkclass)](https://pypi.org/project/pelican-linkclass/)
-![License](https://img.shields.io/pypi/l/pelican-linkclass?color=blue)
+[![Downloads](https://img.shields.io/pypi/dm/pelican-linkclass)](https://pypi.org/project/pelican-linkclass/)
+[![License](https://img.shields.io/pypi/l/pelican-linkclass?color=blue)](https://www.gnu.org/licenses/agpl-3.0.en.html)
 
-This Pelican plugin allows you to set the class attribute of `<a>` elements
-(generated in Markdown by `[ext](link)`) according to whether the link is
-external (i.e., starts with `http://` or `https://`) or internal to the
-Pelican-generated site.
+This Pelican plugin lets you to set the class attribute of `<a>` elements (generated in Markdown by `[ext](link)`), depending on whether the link is external (i.e., starts with `http://` or `https://`) or internal to the Pelican-generated site.
+
+Currently, this plugin only works with Markdown. It has been tested with version 3.0+ of the Python-Markdown module and may not work with earlier versions.
 
-For now, this plugin only works with Markdown. It has been tested with version
-3.0+ of the Python-Markdown module and may not work with previous versions.
 
 Installation
 ------------
 
-This plugin [is available as a package](https://pypi.org/project/pelican-linkclass/)
-at PyPI and can be installed via:
+This plugin [is available as a package](https://pypi.org/project/pelican-linkclass/) at PyPI and can be installed via:
 
 ```
 python -m pip install pelican-linkclass
 ```
 
+As long as there is no `PLUGINS` setting in the Pelican settings file, the newly installed plugin should be detected and enabled automatically. Otherwise, you must add `linkclass` to your existing `PLUGINS` list. For more information, please refer to the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.
+
+
 Configuration
 -------------
 
-In order to avoid clashes with already-defined classes in the user CSS
-style sheets, it is possible to specify the name of the classes that will
-be used. They can be specified in the Pelican setting file with the
-`LINKCLASS` variable, which must be defined as a list of tuples, like this:
+To avoid clashing with classes already defined in user CSS style sheets, it is possible to specify the names of the classes that will be used. This can be done in the Pelican settings file by defining the `LINKCLASS` variable as a list of tuples, such as in this example:
 
 ```python
 'LINKCLASS' = (('EXTERNAL_CLASS', 'name-of-the-class-for-external-links'),
                ('INTERNAL_CLASS', 'name-of-the-class-for-internal-links'))
 ```
 
-The default values for `EXTERNAL_CLASS` and `INTERNAL_CLASS` are,
-respectively, `'external'` and `'internal'`.
+The default values for `EXTERNAL_CLASS` and `INTERNAL_CLASS` are, respectively, `'external'` and `'internal'`.
+
 
 Styling Hyperlinks
 ------------------
 
-One of the possible uses of this plugins is for styling. Suppose that we
-have the following Markdown content in your article:
+One possible use of this plugin is for styling. Suppose that we have the following Markdown content in your article:
 
 ```markdown
 This is an [internal](internal) link and this is an
 [external](http://external.com) link.
 ```
 
-If the default configuration variable values are used, then one possible
-CSS setting could be:
+Using the default configuration variable values, a possible CSS setting could be:
 
 ```css
 a.external:before {
@@ -60,16 +55,13 @@ a.external:before {
 }
 ```
 
-(The file `external-link.png` is also distributed with this plugin. To use it,
-copy it to the appropriate place in your web site source tree, for instance
-in `theme/static/images/`.)
+(The `external-link.png` file is also distributed with this plugin. To use it, copy it to the appropriate location in your website's source tree, for instance in the `theme/static/images/` directory.)
 
-Then, the result will look like the following:
+The result will then look like this:
 
 ![figure](https://github.com/pelican-plugins/linkclass/raw/main/linkclass-example.png)
 
-Note that this plugin also works with reference-style links, as in the
-following example:
+Note that this plugin also works with reference-style links, as in the following example:
 
 ```markdown
 This is an [internal][internal] link and this is an
@@ -79,6 +71,7 @@ This is an [internal][internal] link and this is an
  [external]: http://external.com
 ```
 
+
 Contributing
 ------------
 
@@ -89,6 +82,7 @@ To start contributing to this plugin, review the [Contributing to Pelican][] doc
 [existing issues]: https://github.com/pelican-plugins/linkclass/issues
 [Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html
 
+
 Acknowledgments
 ---------------
 
@@ -100,10 +94,12 @@ Many thanks to [Yuliya Bagriy][] for setting up the package for [PyPI][], to [Lu
 [pytest]: https://pytest.org/
 [Justin Mayer]: https://github.com/justinmayer
 
+
 Author
 ------
 
-Copyright © 2015, 2017, 2019, 2021-2023 Rafael Laboissière (<rafael@laboissiere.net>)
+Copyright © 2015, 2017, 2019, 2021-2023, 2025 Rafael Laboissière (<rafael@laboissiere.net>)
+
 
 License
 -------

{pelican_linkclass-2.1.4 → pelican_linkclass-2.1.6}/pelican/plugins/linkclass/linkclass.py

@@ -15,7 +15,6 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see http://www.gnu.org/licenses/.
 
-
 from pelican import signals
 
 from .mdx_linkclass import LC_CONFIG, LinkClassExtension

{pelican_linkclass-2.1.4 → pelican_linkclass-2.1.6}/pelican/plugins/linkclass/mdx_linkclass.py

@@ -1,6 +1,6 @@
 """Markdown extension for the Link Class plugin for Pelican."""
 
-# Copyright (C) 2015, 2017, 2019, 2023  Rafael Laboissière
+# Copyright (C) 2015, 2017, 2019, 2023, 2025  Rafael Laboissière
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Affero Public License as published by
@@ -15,7 +15,6 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see http://www.gnu.org/licenses/.
 
-
 import re
 
 from markdown.extensions import Extension
@@ -37,7 +36,7 @@ def add_class(elm, config):
     """Utlity function for adding the appropriate class attribute."""
     try:
         m = re.match("^https?://", elm.get("href"))
-        elm.set("class", m and config["EXTERNAL_CLASS"] or config["INTERNAL_CLASS"])
+        elm.set("class", (m and config["EXTERNAL_CLASS"]) or config["INTERNAL_CLASS"])
     except AttributeError:
         pass
     return elm

{pelican_linkclass-2.1.4 → pelican_linkclass-2.1.6}/pelican/plugins/linkclass/test_linkclass.py

@@ -1,6 +1,6 @@
 """Unit testing suite for the Link Class Plugin."""
 
-# Copyright (C) 2015, 2017, 2019, 2021-2023  Rafael Laboissière <rafael@laboissiere.net>  # noqa: E501
+# Copyright (C) 2015, 2017, 2019, 2021-2023, 2025  Rafael Laboissière <rafael@laboissiere.net>  # noqa: E501
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Affero Public License as published by
@@ -65,6 +65,7 @@ class TestLinkClass(unittest.TestCase):
     """Class for testing the <a> output elements generated by the Link Class plugin."""
 
     def setUp(self, override=None):
+        """Initialize the configuration."""
         self.output_path = mkdtemp(prefix=TEST_DIR_PREFIX)
         self.content_path = mkdtemp(prefix=TEST_DIR_PREFIX)
         settings = {
@@ -87,44 +88,22 @@ class TestLinkClass(unittest.TestCase):
             os.path.join(self.content_path, f"{TEST_FILE_STEM}.md"),
             "w",
         ) as fid:
-            template = """Title: Test
+            fid.write(f"""Title: Test
 Date: 1970-01-01
 
-This is an [{}]({}), inline-style link.
-This is an [{}]({}), inline-style link (with http URL).
-This is an [{}]({}), inline-style link (with https URL).
-
-This is an [{}][{}], reference-style link.
-This is an [{}][{}], reference-style link (with http URL).
-This is an [{}][{}], reference-style link (with https URL).
-
- [{}]: {}
- [{}]: {}
- [{}]: {}
-
-"""
-            fid.write(
-                template.format(
-                    INTERNAL_INLINE_TEXT,
-                    INTERNAL_INLINE_LINK,
-                    EXTERNAL_INLINE_TEXT_HTTP,
-                    EXTERNAL_INLINE_LINK_HTTP,
-                    EXTERNAL_INLINE_TEXT_HTTPS,
-                    EXTERNAL_INLINE_LINK_HTTP,
-                    INTERNAL_REFERENCE_TEXT,
-                    INTERNAL_REFERENCE_LABEL,
-                    EXTERNAL_REFERENCE_TEXT_HTTP,
-                    EXTERNAL_REFERENCE_LABEL_HTTP,
-                    EXTERNAL_REFERENCE_TEXT_HTTPS,
-                    EXTERNAL_REFERENCE_LABEL_HTTPS,
-                    INTERNAL_REFERENCE_LABEL,
-                    INTERNAL_REFERENCE_LINK,
-                    EXTERNAL_REFERENCE_LABEL_HTTP,
-                    EXTERNAL_REFERENCE_LINK_HTTP,
-                    EXTERNAL_REFERENCE_LABEL_HTTPS,
-                    EXTERNAL_REFERENCE_LINK_HTTPS,
-                )
-            )
+This is an [{INTERNAL_INLINE_TEXT}]({INTERNAL_INLINE_LINK}), inline-style link.
+This is an [{EXTERNAL_INLINE_TEXT_HTTP}]({EXTERNAL_INLINE_LINK_HTTP}), inline-style link (with http URL).
+This is an [{EXTERNAL_INLINE_TEXT_HTTPS}]({EXTERNAL_INLINE_LINK_HTTP}), inline-style link (with https URL).
+
+This is an [{INTERNAL_REFERENCE_TEXT}][{INTERNAL_REFERENCE_LABEL}], reference-style link.
+This is an [{EXTERNAL_REFERENCE_TEXT_HTTP}][{EXTERNAL_REFERENCE_LABEL_HTTP}], reference-style link (with http URL).
+This is an [{EXTERNAL_REFERENCE_TEXT_HTTPS}][{EXTERNAL_REFERENCE_LABEL_HTTPS}], reference-style link (with https URL).
+
+ [{INTERNAL_REFERENCE_LABEL}]: {INTERNAL_REFERENCE_LINK}
+ [{EXTERNAL_REFERENCE_LABEL_HTTP}]: {EXTERNAL_REFERENCE_LINK_HTTP}
+ [{EXTERNAL_REFERENCE_LABEL_HTTPS}]: {EXTERNAL_REFERENCE_LINK_HTTPS}
+
+""")
 
         # Run the Pelican instance
         self.settings = read_settings(override=settings)

{pelican_linkclass-2.1.4 → pelican_linkclass-2.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pelican-linkclass"
-version = "2.1.4"
+version = "2.1.6"
 description = "Pelican plugin to set anchor tag's class attribute to differentiate between internal and external links"
 authors = [
     { name = "Rafael Laboissière", email = "rafael@laboissiere.net" },
@@ -17,18 +17,18 @@ classifiers = [
     "Framework :: Pelican",
     "Framework :: Pelican :: Plugins",
     "Intended Audience :: End Users/Desktop",
-    "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "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",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Internet :: WWW/HTTP",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-requires-python = ">=3.8.1,<4.0"
+requires-python = ">=3.10"
 dependencies = [
     "pelican>=4.5",
     "py3dns>=3.2",
@@ -40,6 +40,7 @@ text = "AGPL-3.0"
 [project.urls]
 Homepage = "https://github.com/pelican-plugins/linkclass"
 "Issue Tracker" = "https://github.com/pelican-plugins/linkclass/issues"
+Changelog = "https://github.com/pelican-plugins/linkclass/blob/main/CHANGELOG.md"
 Funding = "https://donate.getpelican.com/"
 
 [project.optional-dependencies]
@@ -47,17 +48,17 @@ markdown = [
     "markdown>=3.4",
 ]
 
-[tool.pdm.dev-dependencies]
+[dependency-groups]
 lint = [
-    "black>=23.10.1",
-    "invoke>=2.2.0",
-    "ruff>=0.1.3",
+    "invoke>=2.2",
+    "ruff>=0.14.2,<1.0.0",
 ]
 test = [
+    "invoke>=2.2",
     "markdown>=3.4",
     "pytest>=7.0",
     "pytest-cov>=4.0",
-    "pytest-sugar>=0.9.7",
+    "pytest-sugar>=1.0",
 ]
 
 [tool.pdm.build]
@@ -71,7 +72,7 @@ includes = [
     "pelican/",
 ]
 excludes = [
-    "tasks.py",
+    "**/.DS_Store",
 ]
 
 [tool.autopub]
@@ -80,7 +81,7 @@ git-username = "botpub"
 git-email = "52496925+botpub@users.noreply.github.com"
 append-github-contributor = true
 
-[tool.ruff]
+[tool.ruff.lint]
 select = [
     "B",
     "BLE",
@@ -106,13 +107,13 @@ select = [
 ]
 ignore = [
     "D100",
-    "D102",
     "D104",
     "D203",
     "D213",
+    "ISC001",
 ]
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 combine-as-imports = true
 force-sort-within-sections = true
 known-first-party = [