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

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

@@ -1,6 +1,20 @@
 CHANGELOG
 =========
 
+2.1.4 - 2024-04-14
+------------------
+
+Ensure plugin is included in sdist build
+
+2.1.3 - 2024-04-07
+------------------
+
+Maintainance release (no user visible changes)
+
+* Add Python 3.12 to CI test matrix
+* Switch build system from Hatchling to PDM
+* Fix linters errors
+
 2.1.2 - 2023-10-31
 ------------------
 

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

@@ -1,14 +1,10 @@
 Metadata-Version: 2.1
 Name: pelican-linkclass
-Version: 2.1.2
+Version: 2.1.4
 Summary: Pelican plugin to set anchor tag's class attribute to differentiate between internal and external links
-Project-URL: Homepage, https://github.com/pelican-plugins/linkclass
-Project-URL: Issue Tracker, https://github.com/pelican-plugins/linkclass/issues
-Project-URL: Funding, https://donate.getpelican.com/
-Author-email: Rafael Laboissière <rafael@laboissiere.net>
+Keywords: pelican,plugin,link class
+Author-Email: =?utf-8?q?Rafael_Laboissi=C3=A8re?= <rafael@laboissiere.net>
 License: AGPL-3.0
-License-File: LICENSE
-Keywords: link class,pelican,plugin
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Framework :: Pelican
@@ -21,13 +17,17 @@ 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/linkclass
+Project-URL: Issue tracker, https://github.com/pelican-plugins/linkclass/issues
+Project-URL: Funding, https://donate.getpelican.com/
 Requires-Python: <4.0,>=3.8.1
 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

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

@@ -87,8 +87,7 @@ class TestLinkClass(unittest.TestCase):
             os.path.join(self.content_path, f"{TEST_FILE_STEM}.md"),
             "w",
         ) as fid:
-            fid.write(
-                """Title: Test
+            template = """Title: Test
 Date: 1970-01-01
 
 This is an [{}]({}), inline-style link.
@@ -103,7 +102,9 @@ This is an [{}][{}], reference-style link (with https URL).
  [{}]: {}
  [{}]: {}
 
-""".format(
+"""
+            fid.write(
+                template.format(
                     INTERNAL_INLINE_TEXT,
                     INTERNAL_INLINE_LINK,
                     EXTERNAL_INLINE_TEXT_HTTP,

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

@@ -1,11 +1,16 @@
 [project]
 name = "pelican-linkclass"
-version = "2.1.2"
+version = "2.1.4"
 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"}]
-license = {text = "AGPL-3.0"}
+authors = [
+    { name = "Rafael Laboissière", email = "rafael@laboissiere.net" },
+]
 readme = "README.md"
-keywords = ["pelican", "plugin", "link class"]
+keywords = [
+    "pelican",
+    "plugin",
+    "link class",
+]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Environment :: Console",
@@ -19,6 +24,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",
 ]
@@ -28,13 +34,18 @@ dependencies = [
     "py3dns>=3.2",
 ]
 
+[project.license]
+text = "AGPL-3.0"
+
 [project.urls]
 Homepage = "https://github.com/pelican-plugins/linkclass"
 "Issue Tracker" = "https://github.com/pelican-plugins/linkclass/issues"
 Funding = "https://donate.getpelican.com/"
 
 [project.optional-dependencies]
-markdown = ["markdown>=3.4"]
+markdown = [
+    "markdown>=3.4",
+]
 
 [tool.pdm.dev-dependencies]
 lint = [
@@ -49,6 +60,20 @@ test = [
     "pytest-sugar>=0.9.7",
 ]
 
+[tool.pdm.build]
+source-includes = [
+    "CHANGELOG.md",
+    "CONTRIBUTING.md",
+    "external-link.png",
+    "linkclass-example.png",
+]
+includes = [
+    "pelican/",
+]
+excludes = [
+    "tasks.py",
+]
+
 [tool.autopub]
 project-name = "Link Class"
 git-username = "botpub"
@@ -57,42 +82,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_linkclass-2.1.2/.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_linkclass-2.1.2/.github/FUNDING.yml

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

pelican_linkclass-2.1.2/.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-linkclass/"
-
-      - 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_linkclass-2.1.2/.gitignore

@@ -1,6 +0,0 @@
-*.pyc
-__pycache__/
-/dist/
-/*.egg-info
-/build/
-pdm.lock

pelican_linkclass-2.1.2/.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.5.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.10.1
-    hooks:
-      - id: black
-
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.3
-    hooks:
-      - id: ruff

pelican_linkclass-2.1.2/RELEASE.md

@@ -1,3 +0,0 @@
-Release type: patch
-
-Fix project name

pelican_linkclass-2.1.2/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 = "linkclass"
-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))