pelican-avatar 1.0.5__tar.gz → 1.0.9__tar.gz

{pelican_avatar-1.0.5 → pelican_avatar-1.0.9}/CHANGELOG.md

@@ -1,6 +1,32 @@
 CHANGELOG
 =========
 
+1.0.9 - 2024-04-14
+------------------
+
+Ensure plugin is included in sdist build
+
+1.0.8 - 2024-04-11
+------------------
+
+Maintainance release (no user visible changes)
+
+* Add acknowledgments to Lucas Cimon and Christian Clauss
+* Update list of Copyright years
+
+1.0.7 - 2024-04-11
+------------------
+
+Code improvement (no user visible changes)
+
+1.0.6 - 2024-04-07
+------------------
+
+Maintainance release (no user visible changes)
+
+* Add Python 3.12 to CI test matrix
+* Switch build system from Hatchling to PDM
+
 1.0.5 - 2023-10-30
 ------------------
 

{pelican_avatar-1.0.5 → pelican_avatar-1.0.9}/PKG-INFO

@@ -1,14 +1,10 @@
 Metadata-Version: 2.1
 Name: pelican-avatar
-Version: 1.0.5
+Version: 1.0.9
 Summary: Libravatar/Gravatar plugin for Pelican
-Project-URL: Homepage, https://github.com/pelican-plugins/avatar
-Project-URL: Issue Tracker, https://github.com/pelican-plugins/avatar/issues
-Project-URL: Funding, https://donate.getpelican.com/
-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
-License-File: LICENSE
-Keywords: gravatar,libravatar,pelican,plugin
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Framework :: Pelican
@@ -21,15 +17,19 @@ 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: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Project-URL: Homepage, https://github.com/pelican-plugins/avatar
+Project-URL: Issue tracker, https://github.com/pelican-plugins/avatar/issues
+Project-URL: Funding, https://donate.getpelican.com/
 Requires-Python: <4.0,>=3.8.1
-Requires-Dist: libgravatar>=0.2.5
 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
@@ -157,15 +157,17 @@ To start contributing to this plugin, review the [Contributing to Pelican][] doc
 Acknowledgments
 ---------------
 
-Thanks to [Justin Mayer][] for helping with migration of this plugin under the Pelican Plugins organization and  to [Troy Curtis][] for adding support for page generator and global generator context and for making improvements in the Poetry workflow.
+Thanks to [Justin Mayer][] for helping with migration of this plugin under the Pelican Plugins organization, to [Troy Curtis][] for adding support for page generator and global generator context and for making improvements in the Poetry workflow, to [Lucas Cimon][] for fixes in the test suit and in the CI support, and to [Christian Clauss][] for Python 3 porting.
 
 [Justin Mayer]: https://github.com/justinmayer
 [Troy Curtis]: https://github.com/troycurtisjr
+[Lucas Cimon]: https://github.com/Lucas-C
+[Christian Clauss]: https://github.com/cclauss
 
 Author
 ------
 
-Copyright (C) 2015, 2021-2023  Rafael Laboissière (<rafael@laboissiere.net>)
+Copyright (C) 2015, 2021-2024  Rafael Laboissière (<rafael@laboissiere.net>)
 
 License
 -------

{pelican_avatar-1.0.5 → pelican_avatar-1.0.9}/README.md

@@ -123,15 +123,17 @@ To start contributing to this plugin, review the [Contributing to Pelican][] doc
 Acknowledgments
 ---------------
 
-Thanks to [Justin Mayer][] for helping with migration of this plugin under the Pelican Plugins organization and  to [Troy Curtis][] for adding support for page generator and global generator context and for making improvements in the Poetry workflow.
+Thanks to [Justin Mayer][] for helping with migration of this plugin under the Pelican Plugins organization, to [Troy Curtis][] for adding support for page generator and global generator context and for making improvements in the Poetry workflow, to [Lucas Cimon][] for fixes in the test suit and in the CI support, and to [Christian Clauss][] for Python 3 porting.
 
 [Justin Mayer]: https://github.com/justinmayer
 [Troy Curtis]: https://github.com/troycurtisjr
+[Lucas Cimon]: https://github.com/Lucas-C
+[Christian Clauss]: https://github.com/cclauss
 
 Author
 ------
 
-Copyright (C) 2015, 2021-2023  Rafael Laboissière (<rafael@laboissiere.net>)
+Copyright (C) 2015, 2021-2024  Rafael Laboissière (<rafael@laboissiere.net>)
 
 License
 -------

{pelican_avatar-1.0.5 → pelican_avatar-1.0.9}/pelican/plugins/avatar/avatar.py

@@ -1,6 +1,6 @@
 """Avatar plugin for Pelican."""
 
-# Copyright (C) 2015, 2021-2023  Rafael Laboissière <rafael@laboissiere.net>
+# 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
@@ -40,19 +40,23 @@ def gen_avatar_url(settings, email):
     email = email.lower()
     # Compose URL
     if settings.get("AVATAR_USE_GRAVATAR"):
-        url = Gravatar(email).get_image()
+        params = {}
+        if missing:
+            params["default"] = missing
+        if size:
+            params["size"] = size
+        url = Gravatar(email).get_image(**params)
     else:
         url = libravatar_url(email)
-
-    # Add eventual "missing picture" option
-    if missing or size:
-        url = url + "?"
-        if missing:
-            url = url + "d=" + missing
+        if missing or size:
+            url = url + "?"
+            if missing:
+                url = url + "d=" + missing
+                if size:
+                    url = url + "&"
             if size:
-                url = url + "&"
-        if size:
-            url = url + "s=" + str(size)
+                url = url + "s=" + str(size)
+
     return url
 
 

{pelican_avatar-1.0.5 → pelican_avatar-1.0.9}/pyproject.toml

@@ -1,11 +1,17 @@
 [project]
 name = "pelican-avatar"
-version = "1.0.5"
+version = "1.0.9"
 description = "Libravatar/Gravatar plugin for Pelican"
-authors = [{name = "Rafael Laboissière", email = "rafael@laboissiere.net"}]
-license = {text = "AGPL-3.0"}
+authors = [
+    { name = "Rafael Laboissière", email = "rafael@laboissiere.net" },
+]
 readme = "README.md"
-keywords = ["pelican", "plugin", "libravatar", "gravatar"]
+keywords = [
+    "pelican",
+    "plugin",
+    "libravatar",
+    "gravatar",
+]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Environment :: Console",
@@ -19,6 +25,7 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Internet :: WWW/HTTP",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
@@ -30,13 +37,18 @@ dependencies = [
     "pylibravatar>=1.7",
 ]
 
+[project.license]
+text = "AGPL-3.0"
+
 [project.urls]
 Homepage = "https://github.com/pelican-plugins/avatar"
 "Issue Tracker" = "https://github.com/pelican-plugins/avatar/issues"
 Funding = "https://donate.getpelican.com/"
 
 [project.optional-dependencies]
-markdown = ["markdown>=3.4"]
+markdown = [
+    "markdown>=3.4",
+]
 
 [tool.pdm.dev-dependencies]
 lint = [
@@ -51,6 +63,18 @@ test = [
     "pytest-sugar>=0.9.7",
 ]
 
+[tool.pdm.build]
+source-includes = [
+    "CHANGELOG.md",
+    "CONTRIBUTING.md",
+    "avatar-example.png",
+]
+includes = [
+    "pelican/",
+]
+excludes = [
+    "tasks.py",
+]
 
 [tool.autopub]
 project-name = "Avatar"
@@ -60,42 +84,45 @@ append-github-contributor = true
 
 [tool.ruff]
 select = [
-  "B",   # flake8-bugbear
-  "BLE", # flake8-blind-except
-  "C4",  # flake8-comprehensions
-  "D",   # pydocstyle
-  "E",   # pycodestyle
-  "F",   # pyflakes
-  "I",   # isort
-  "ICN", # flake8-import-conventions
-  "ISC", # flake8-implicit-str-concat
-  "PGH", # pygrep-hooks
-  "PL",  # pylint
-  "RET", # flake8-return
-  "RUF", # ruff-specific rules
-  "SIM", # flake8-simplify
-  "T10", # flake8-debugger
-  "T20", # flake8-print
-  "TID", # flake8-tidy-imports
-  "TRY", # tryceratops
-  "UP",  # pyupgrade
-  "W",   # pycodestyle
-  "YTT", # flake8-2020
+    "B",
+    "BLE",
+    "C4",
+    "D",
+    "E",
+    "F",
+    "I",
+    "ICN",
+    "ISC",
+    "PGH",
+    "PL",
+    "RET",
+    "RUF",
+    "SIM",
+    "T10",
+    "T20",
+    "TID",
+    "TRY",
+    "UP",
+    "W",
+    "YTT",
 ]
-
 ignore = [
-  "D100",    # missing docstring in public module
-  "D102",    # missing docstring in public method
-  "D104",    # missing docstring in public package
+    "D100",
+    "D102",
+    "D104",
+    "D203",
+    "D213",
 ]
 
-target-version = "py38"
-
 [tool.ruff.isort]
 combine-as-imports = true
 force-sort-within-sections = true
-known-first-party = ["pelican"]
+known-first-party = [
+    "pelican",
+]
 
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"

pelican_avatar-1.0.5/.editorconfig

@@ -1,15 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 4
-indent_style = space
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.py]
-max_line_length = 88
-
-[*.yml]
-indent_size = 2

pelican_avatar-1.0.5/.github/FUNDING.yml

@@ -1,5 +0,0 @@
----
-
-github: justinmayer
-custom: https://donate.getpelican.com
-liberapay: pelican

pelican_avatar-1.0.5/.github/workflows/main.yml

@@ -1,97 +0,0 @@
-name: build
-
-on: [push, pull_request]
-
-env:
-  PYTEST_ADDOPTS: "--color=yes"
-
-jobs:
-  test:
-    name: Test - ${{ matrix.python-version }}
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up Python ${{ matrix.python-version }} & PDM
-        uses: pdm-project/setup-pdm@v3
-        with:
-          python-version: ${{ matrix.python-version }}
-          cache: true
-          cache-dependency-path: ./pyproject.toml
-
-      - name: Install dependencies
-        run: pdm install
-
-      - name: Run tests
-        run: pdm run invoke tests
-
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Validate links in Markdown files
-        uses: JustinBeckwith/linkinator-action@v1
-        with:
-          retry: true
-          linksToSkip: "https://pypi.org/project/pelican-avatar/"
-
-      - name: Set up Python & PDM
-        uses: pdm-project/setup-pdm@v3
-        with:
-          python-version: "3.10"
-          cache: true
-          cache-dependency-path: ./pyproject.toml
-
-      - name: Install dependencies
-        run: pdm install
-
-      - name: Run linters
-        run: pdm run invoke lint --diff
-
-  deploy:
-    name: Deploy
-    environment: Deployment
-    needs: [test, lint]
-    runs-on: ubuntu-latest
-    if: github.ref=='refs/heads/main' && github.event_name!='pull_request'
-
-    permissions:
-      contents: write
-      id-token: write
-
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          token: ${{ secrets.GH_TOKEN }}
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.10"
-
-      - name: Check release
-        id: check_release
-        run: |
-          python -m pip install autopub[github]
-          autopub check
-
-      - name: Publish
-        if: ${{ steps.check_release.outputs.autopub_release=='true' }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-        run: |
-          autopub prepare
-          autopub commit
-          autopub build
-          autopub githubrelease
-
-      - name: Upload package to PyPI
-        if: ${{ steps.check_release.outputs.autopub_release=='true' }}
-        uses: pypa/gh-action-pypi-publish@release/v1

pelican_avatar-1.0.5/.gitignore

@@ -1,2 +0,0 @@
-/poetry.lock
-/pelican/plugins/avatar/__pycache__/

pelican_avatar-1.0.5/.pre-commit-config.yaml

@@ -1,31 +0,0 @@
----
-ci:
-  autoupdate_schedule: quarterly
-
-# See https://pre-commit.com/hooks.html for info on hooks
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
-    hooks:
-      - id: check-added-large-files
-      - id: check-ast
-      - id: check-case-conflict
-      - id: check-docstring-first
-      - id: check-merge-conflict
-      - id: check-toml
-      - id: check-yaml
-      - id: debug-statements
-      - id: detect-private-key
-      - id: end-of-file-fixer
-      - id: forbid-new-submodules
-      - id: trailing-whitespace
-
-  - repo: https://github.com/psf/black
-    rev: 23.9.1
-    hooks:
-      - id: black
-
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.3
-    hooks:
-      - id: ruff

pelican_avatar-1.0.5/RELEASE.md

@@ -1,3 +0,0 @@
-Release type: patch
-
-Update list of years in Copyright notices

pelican_avatar-1.0.5/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))

pelican_avatar-1.0.5/tox.ini

@@ -1,3 +0,0 @@
-[flake8]
-max-line-length = 88
-ignore = E203, W503