pelican-avatar 1.0.8__py3-none-any.whl → 1.0.10__py3-none-any.whl

pelican/plugins/avatar/__init__.py

@@ -0,0 +1 @@
+from .avatar import *  # NOQA: F403

pelican/plugins/avatar/avatar.py

@@ -0,0 +1,92 @@
+"""Avatar plugin for Pelican."""
+
+# Copyright (C) 2015, 2021-2024  Rafael Laboissière <rafael@laboissiere.net>
+#
+# 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
+# the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Affero General Public License for more details.
+#
+# 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 libgravatar import Gravatar
+from libravatar import libravatar_url
+
+from pelican import signals
+
+
+def initialize(pelicanobj):
+    """Initialize the Avatar plugin."""
+    pelicanobj.settings.setdefault("AVATAR_MISSING", None)
+    pelicanobj.settings.setdefault("AVATAR_SIZE", None)
+    pelicanobj.settings.setdefault("AVATAR_USE_GRAVATAR", None)
+
+
+def gen_avatar_url(settings, email):
+    """Generate the appropriate libravatar/gravatar URL based on the provided email."""
+    # Early exit if there is nothing to do
+    if not email:
+        return None
+
+    missing = settings.get("AVATAR_MISSING")
+    size = settings.get("AVATAR_SIZE")
+
+    email = email.lower()
+    # Compose URL
+    if settings.get("AVATAR_USE_GRAVATAR"):
+        params = {}
+        if missing:
+            params["default"] = missing
+        if size:
+            params["size"] = size
+        url = Gravatar(email).get_image(**params)
+    else:
+        url = libravatar_url(email)
+        if missing or size:
+            url = url + "?"
+            if missing:
+                url = url + "d=" + missing
+                if size:
+                    url = url + "&"
+            if size:
+                url = url + "s=" + str(size)
+
+    return url
+
+
+def add_avatar_context(generator):
+    """Add generator context connector for Avatar plugin."""
+    # This adds the avatar URL to the global generator context based on the
+    # global setting.
+    email = generator.settings.get("AVATAR_AUTHOR_EMAIL")
+    url = gen_avatar_url(generator.settings, email)
+    if url:
+        generator.context["author_avatar"] = url
+
+
+def add_avatar(generator, metadata):
+    """Add Avatar URL to the article/page metadata."""
+    # Check the presence of the Email header
+    if "email" in metadata:
+        email = metadata["email"]
+    else:
+        email = generator.settings.get("AVATAR_AUTHOR_EMAIL")
+
+    url = gen_avatar_url(generator.settings, email)
+    if url:
+        # Add URL to the article/page metadata
+        metadata["author_avatar"] = url
+
+
+def register():
+    """Register the Avatar plugin with Pelican."""
+    signals.initialized.connect(initialize)
+    signals.article_generator_context.connect(add_avatar)
+    signals.page_generator_context.connect(add_avatar)
+    signals.generator_init.connect(add_avatar_context)

pelican/plugins/avatar/test_avatar.py

@@ -0,0 +1,160 @@
+"""Unit testing suite for the Avatar Plugin."""
+
+# Copyright (C) 2015, 2021-2023  Rafael Laboissiere <rafael@laboissiere.net>
+#
+# 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
+# the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Affero General Public License for more details.
+#
+# 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 os
+from shutil import rmtree
+from tempfile import mkdtemp
+import unittest
+
+from libgravatar import Gravatar
+from libravatar import libravatar_url
+
+from pelican import Pelican
+from pelican.settings import read_settings
+
+from . import avatar
+
+GLOBAL_AUTHOR_EMAIL = "homer.simpson@example.com"
+ARTICLE_AUTHOR_EMAIL = "bart.simpson@example.com"
+GLOBAL_GRAVATAR_URL = Gravatar(GLOBAL_AUTHOR_EMAIL).get_image()
+GLOBAL_LIBRVATAR_URL = libravatar_url(GLOBAL_AUTHOR_EMAIL)
+ARTICLE_GRAVATAR_URL = Gravatar(ARTICLE_AUTHOR_EMAIL).get_image()
+ARTICLE_LIBRAVATAR_URL = libravatar_url(ARTICLE_AUTHOR_EMAIL)
+
+
+class TestAvatarURL(unittest.TestCase):
+    """Class for testing the URL output of the Avatar plugin."""
+
+    def setUp(self, override=None):
+        """Set up the test environment."""
+        self.output_path = mkdtemp(prefix="pelicantests.")
+        self.content_path = mkdtemp(prefix="pelicantests.")
+        with open(
+            os.path.join(self.content_path, "article_infos.html"), "w"
+        ) as article_infos_file:
+            article_infos_file.write(
+                """
+<footer class="post-info">
+        <div align="center">
+                <img src="{{ article.author_avatar }}">
+        </div>
+</footer>
+"""
+            )
+
+        with open(
+            os.path.join(self.content_path, "global_info.html"), "w"
+        ) as global_infos_file:
+            global_infos_file.write(
+                """
+<footer class="post-info">
+        <div align="center">
+                <img src="{{ author_avatar }}">
+        </div>
+</footer>
+"""
+            )
+
+        settings = {
+            "PATH": self.content_path,
+            "THEME_TEMPLATES_OVERRIDES": [self.content_path],
+            "OUTPUT_PATH": self.output_path,
+            "PLUGINS": [avatar],
+            "CACHE_CONTENT": False,
+            "AVATAR_AUTHOR_EMAIL": GLOBAL_AUTHOR_EMAIL,
+        }
+        if override:
+            settings.update(override)
+
+        with open(
+            os.path.join(self.content_path, "global_test.md"), "w"
+        ) as test_md_file:
+            test_md_file.write("Title: Global Test\nDate: 2019-09-05\n\n")
+
+        with open(os.path.join(self.content_path, "test.md"), "w") as test_md_file:
+            test_md_file.write(
+                "Title: Test\nDate: 2019-09-05\nEmail: " + ARTICLE_AUTHOR_EMAIL + "\n\n"
+            )
+
+        self.settings = read_settings(override=settings)
+        pelican = Pelican(settings=self.settings)
+        pelican.run()
+
+    def tearDown(self):
+        """Tidy up the test environment."""
+        rmtree(self.output_path)
+        rmtree(self.content_path)
+
+    def _assert_url_in_file(self, filename, url, options):
+        with open(os.path.join(self.output_path, filename)) as test_html_file:
+            found = False
+            search_url = url + options
+            for line in test_html_file:
+                if search_url in line:
+                    found = True
+                    break
+            assert found
+
+    def test_url(self, options=""):
+        """Test whether the Avatar URL appears in the generated HTML file."""
+        if self.settings["AVATAR_USE_GRAVATAR"]:
+            global_base_url = GLOBAL_GRAVATAR_URL
+            article_base_url = ARTICLE_GRAVATAR_URL
+        else:
+            global_base_url = GLOBAL_LIBRVATAR_URL
+            article_base_url = ARTICLE_LIBRAVATAR_URL
+
+        self._assert_url_in_file("test.html", article_base_url, options)
+        self._assert_url_in_file("global-test.html", global_base_url, options)
+
+
+class TestAvatarMissing(TestAvatarURL):
+    """Class for testing the "missing picture" option."""
+
+    def setUp(self, override=None):
+        """Set up the test environment."""
+        self.library = "wavatar"
+        TestAvatarURL.setUp(self, override={"AVATAR_MISSING": self.library})
+
+    def test_url(self):
+        """Test whether the 'd' option appears in the Avatar URL."""
+        TestAvatarURL.test_url(self, r"?d=" + self.library)
+
+
+class TestAvatarSize(TestAvatarURL):
+    """Class for testing the size option."""
+
+    def setUp(self, override=None):
+        """Set up the test environment."""
+        self.size = 100
+        TestAvatarURL.setUp(self, override={"AVATAR_SIZE": self.size})
+
+    def test_url(self):
+        """Test whether the 's' option appears in the Avatar URL."""
+        TestAvatarURL.test_url(self, r"?s=" + str(self.size))
+
+
+class TestAvatarUseGravatar(TestAvatarURL):
+    """Class for testing the 'use Gravatar' option."""
+
+    def setUp(self, override=None):
+        """Set up the test environment."""
+        TestAvatarURL.setUp(self, override={"AVATAR_USE_GRAVATAR": True})
+
+    def test_url(self):
+        """Test whether Gravatar is used."""
+        TestAvatarURL.test_url(self)

{pelican_avatar-1.0.8.dist-info → pelican_avatar-1.0.10.dist-info}/METADATA

@@ -1,16 +1,16 @@
 Metadata-Version: 2.1
 Name: pelican-avatar
-Version: 1.0.8
+Version: 1.0.10
 Summary: Libravatar/Gravatar plugin for Pelican
-Keywords: pelican plugin libravatar gravatar
-Author-Email: Rafael Laboissière <rafael@laboissiere.net>
+Keywords: pelican,plugin,libravatar,gravatar
+Author-Email: =?utf-8?q?Rafael_Laboissi=C3=A8re?= <rafael@laboissiere.net>
 License: AGPL-3.0
 Classifier: Development Status :: 5 - Production/Stable
 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
@@ -28,8 +28,8 @@ Requires-Dist: pelican>=4.5
 Requires-Dist: libgravatar>=0.2.5
 Requires-Dist: py3dns>=3.2
 Requires-Dist: pylibravatar>=1.7
-Requires-Dist: markdown>=3.4; extra == "markdown"
 Provides-Extra: markdown
+Requires-Dist: markdown>=3.4; extra == "markdown"
 Description-Content-Type: text/markdown
 
 Avatar: A Plugin for Pelican
@@ -37,7 +37,8 @@ Avatar: A Plugin for Pelican
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/pelican-plugins/avatar/main.yml?branch=main)](https://github.com/pelican-plugins/avatar/actions)
 [![PyPI Version](https://img.shields.io/pypi/v/pelican-avatar)](https://pypi.org/project/pelican-avatar/)
-![License](https://img.shields.io/pypi/l/pelican-avatar?color=blue)
+[![Downloads](https://img.shields.io/pypi/dm/pelican-avatar)](https://pypi.org/project/pelican-avatar/)
+[![License](https://img.shields.io/pypi/l/pelican-avatar?color=blue)](https://www.gnu.org/licenses/agpl-3.0.en.html)
 
 This plugin allows the inclusion of [Libravatar][] or [Gravatar][] user profile pictures, corresponding to the email address of the article's author.
 
@@ -51,6 +52,8 @@ This plugin can be installed via:
 
     python -m pip install pelican-avatar
 
+As long as you have not explicitly added a `PLUGINS` setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add `avatar` to your existing `PLUGINS` list. For more information, please see the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.
+
 Usage
 -----
 

pelican_avatar-1.0.10.dist-info/RECORD

@@ -0,0 +1,8 @@
+pelican/plugins/avatar/__init__.py,sha256=tt8WB0hhhW_jgsRgQNEn-r3TKl1RJRglrXKeudL8zO0,36
+pelican/plugins/avatar/avatar.py,sha256=zjaTE3Hp2Q5Fm7cseenMXzOgeCgdYxLFK6kzLUQNavI,3065
+pelican/plugins/avatar/test_avatar.py,sha256=e9xkj-0G1rZ23LedjvxsFh9ERSVbt2JFr78DeItb5wk,5511
+pelican_avatar-1.0.10.dist-info/METADATA,sha256=EoGYJt4bwWvJC6F2CPOOXoaU73J37A59VTHsPb4n4oo,7345
+pelican_avatar-1.0.10.dist-info/WHEEL,sha256=Vza3XR51HW1KmFP0iIMUVYIvz0uQuKJpIXKYOBGQyFQ,90
+pelican_avatar-1.0.10.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+pelican_avatar-1.0.10.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+pelican_avatar-1.0.10.dist-info/RECORD,,

{pelican_avatar-1.0.8.dist-info → pelican_avatar-1.0.10.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.1.8)
+Generator: pdm-backend (2.4.1)
 Root-Is-Purelib: true
 Tag: py3-none-any

pelican_avatar-1.0.10.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+
+[gui_scripts]
+

pelican_avatar-1.0.8.dist-info/RECORD

@@ -1,5 +0,0 @@
-pelican_avatar-1.0.8.dist-info/METADATA,sha256=moAqqvUJzexH52upKopx_BTWAZpC9lftSHhkGohMR70,6813
-pelican_avatar-1.0.8.dist-info/WHEEL,sha256=N2J68yzZqJh3mI_Wg92rwhw0rtJDFpZj9bwQIMJgaVg,90
-pelican_avatar-1.0.8.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-tasks.py,sha256=vSB2IaG--1O3QmrCUYQt_ZXF2r3b7t3uRheSmhQ5MPA,3164
-pelican_avatar-1.0.8.dist-info/RECORD,,

tasks.py

@@ -1,99 +0,0 @@
-from inspect import cleandoc
-import logging
-import os
-from pathlib import Path
-from shutil import which
-
-from invoke import task
-
-logger = logging.getLogger(__name__)
-
-PKG_NAME = "avatar"
-PKG_PATH = Path(f"pelican/plugins/{PKG_NAME}")
-
-ACTIVE_VENV = os.environ.get("VIRTUAL_ENV", None)
-VENV_HOME = Path(os.environ.get("WORKON_HOME", "~/.local/share/virtualenvs"))
-VENV_PATH = Path(ACTIVE_VENV) if ACTIVE_VENV else (VENV_HOME.expanduser() / PKG_NAME)
-VENV = str(VENV_PATH.expanduser())
-BIN_DIR = "bin" if os.name != "nt" else "Scripts"
-VENV_BIN = Path(VENV) / Path(BIN_DIR)
-
-TOOLS = ("pdm", "pre-commit")
-PDM = which("pdm") if which("pdm") else (VENV_BIN / "pdm")
-CMD_PREFIX = f"{VENV_BIN}/" if ACTIVE_VENV else f"{PDM} run "
-PRECOMMIT = which("pre-commit") if which("pre-commit") else f"{CMD_PREFIX}pre-commit"
-PTY = os.name != "nt"
-
-
-@task
-def tests(c, deprecations=False):
-    """Run the test suite, optionally with `--deprecations`."""
-    deprecations_flag = "" if deprecations else "-W ignore::DeprecationWarning"
-    c.run(f"{CMD_PREFIX}pytest {deprecations_flag}", pty=PTY)
-
-
-@task
-def black(c, check=False, diff=False):
-    """Run Black auto-formatter, optionally with `--check` or `--diff`."""
-    check_flag, diff_flag = "", ""
-    if check:
-        check_flag = "--check"
-    if diff:
-        diff_flag = "--diff"
-    c.run(f"{CMD_PREFIX}black {check_flag} {diff_flag} {PKG_PATH} tasks.py", pty=PTY)
-
-
-@task
-def ruff(c, fix=False, diff=False):
-    """Run Ruff to ensure code meets project standards."""
-    diff_flag, fix_flag = "", ""
-    if fix:
-        fix_flag = "--fix"
-    if diff:
-        diff_flag = "--diff"
-    c.run(f"{CMD_PREFIX}ruff check {diff_flag} {fix_flag} .", pty=PTY)
-
-
-@task
-def lint(c, fix=False, diff=False):
-    """Check code style via linting tools."""
-    ruff(c, fix=fix, diff=diff)
-    black(c, check=(not fix), diff=diff)
-
-
-@task
-def tools(c):
-    """Install development tools in the virtual environment if not already on PATH."""
-    for tool in TOOLS:
-        if not which(tool):
-            logger.info(f"** Installing {tool} **")
-            c.run(f"{CMD_PREFIX}pip install {tool}")
-
-
-@task
-def precommit(c):
-    """Install pre-commit hooks to .git/hooks/pre-commit."""
-    logger.info("** Installing pre-commit hooks **")
-    c.run(f"{PRECOMMIT} install")
-
-
-@task
-def setup(c):
-    """Set up the development environment."""
-    if which("pdm") or ACTIVE_VENV:
-        tools(c)
-        c.run(f"{CMD_PREFIX}python -m pip install --upgrade pip", pty=PTY)
-        c.run(f"{PDM} update --dev", pty=PTY)
-        precommit(c)
-        logger.info("\nDevelopment environment should now be set up and ready!\n")
-    else:
-        error_message = """
-            PDM is not installed, and there is no active virtual environment available.
-            You can either manually create and activate a virtual environment, or you can
-            install PDM via:
-
-            curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python3 -
-
-            Once you have taken one of the above two steps, run `invoke setup` again.
-            """  # noqa: E501
-        raise SystemExit(cleandoc(error_message))