chore: merge branch

Author: mhucka

.editorconfig

@@ -0,0 +1,42 @@
+# Summary: EditorConfig file for this project.         -*- conf -*-
+#
+# For more information, see https://EditorConfig.org
+#
+# Copyright 2024 California Institute of Technology.
+# License: Modified BSD 3-clause – see file "LICENSE" in the project website.
+# Website: https://github.com/caltechlibrary/iga
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 90
+tab_width = 4
+trim_trailing_whitespace = true
+
+[*.cfg]
+indent_size = 2
+
+[*.json]
+indent_size = 2
+
+[*.{yml, yaml}]
+indent_size = 2
+
+# Shell scripts on Windows.
+[*.{cmd, bat}]
+end_of_line = crlf
+
+[Makefile, makefile]
+indent_size = 4
+indent_style = tab
+tab_width = 8
+
+[.applescript]
+indent_size = 4
+indent_style = tab
+tab_width = 4

.flake8

@@ -1,14 +1,9 @@
-# -*- conf-toml -*-
-# @file    .flake8
-# @brief   Project-wide Flake8 configuration
-# @created 2022-12-08
-# @license Please see the file named LICENSE in the project directory
-# @website https://github.com/caltechlibrary/iga
+# Summary: project-wide Flake8 configuration.                 -*- conf-toml -*-
 #
 # Note: as of version 4.0, flake8 does NOT read global configuration files
-# from ~/.flake8 or ~/.config/flake8.  If you had such a config file of your
+# from ~/.flake8 or ~/.config/flake8. If you had such a config file of your
 # own, and you're looking at this config file and wondering how the two will
-# interaction, the answer is simple: they won't.  Only this file matters.
+# interaction, the answer is simple: they won't. Only this file matters.
 #
 # The following flake8 plugins are assumed to be installed:
 #   flake8-bugbear
@@ -18,6 +13,10 @@
 #   flake8-implicit-str-concat
 #   flake8-pie
 #   flake8_simplify
+#
+# Copyright 2024 California Institute of Technology.
+# License: Modified BSD 3-clause – see file "LICENSE" in the project website.
+# Website: https://github.com/caltechlibrary/iga
 
 [flake8]
 ignore =
@@ -46,6 +45,7 @@ per-file-ignores =
     # keyword/parameter equals"). It would be better to disable E251 just for
     # that block in the file, BUT flake8 only recognizes per-line annotations,
     # so there's no way to tell it to ignore a rule only for a block of code.
+    iga/__init__.py: E221
     iga/__main__.py: E251
     tests/*: F403, W391, E202, E251
-    vendor:*: A003, E301, E302, E305, W291, W293, W605, F821
+    vendor:*: A003, E301, E302, E305, W291, W293, W605, F821

.gitattributes

@@ -1,36 +1,71 @@
-# -*- mode: sh; -*-
+# Summary: repository-specific file attributes assignments for git.
+#
+# Copyright 2024 California Institute of Technology.
+# License: Modified BSD 3-clause – see file "LICENSE" in the project website.
+# Website: https://github.com/caltechlibrary/iga
 
-# Set the default behavior, in case people don't have core.autocrlf set.
-# .............................................................................
+# Set default interpretation of line endings ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 * text=auto
 
-# Specify what's text and should be normalized.
-# .............................................................................
-
-*.py text
-*.in text
-*.rst text
-*.cfg text
-*.ini text
-*.yml text
-*.json text
-*.bat text
-*.sh text
-LICENSE text
-CONTRIBUTING text
-
-# Denote all files that are truly binary and should not be modified.
-# .............................................................................
-
-*.png binary
-*.jpg binary
-*.xls binary
-*.doc binary
-
-# This next one is because in other projects, we've had problems with git
-# getting confused about line endings when people using Windows and Mac edit
-# the same files.
-# .............................................................................
-
-*.csv binary diff=csv
+# Interpretation of common text files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*.bat	text eol=crlf
+*.cff	text
+*.cfg	text
+*.css	text diff=css
+*.env	text
+*.html	text diff=html
+*.ini	text
+*.ipynb	text eol=lf
+*.js	text
+*.json	text
+*.md	text diff=markdown
+*.py	text diff=python
+*.rst	text
+*.sh	text
+*.sql	text
+*.svg	text
+*.toml	text
+*.tex	text diff=tex
+*.txt	text
+*.yaml	text merge=yaml
+*.yml	text merge=yaml
+
+# RC files like .babelrc, .eslintrc, etc.
+*.*rc	text
+
+LICENSE		text
+Makefile	text
+
+*.gitattributes	text
+*.*ignore	text
+.gitconfig	text
+
+# Interpretation of common binary files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*.bz	binary
+*.DOC	binary
+*.doc	binary
+*.DOCX	binary
+*.docx	binary
+*.DOT	binary
+*.dot	binary
+*.gz	binary
+*.jpeg	binary
+*.jpg	binary
+*.PDF	binary
+*.pdf	binary
+*.RTF	binary
+*.rtf	binary
+*.tar	binary
+*.tgz	binary
+*.tif	binary
+*.tiff	binary
+*.xls	binary
+*.zip	binary
+
+# Special case for CSV files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# This avoids compatibility issues between Windows and Mac.
+
+*.csv	text eol=crlf

.github/workflows/archive-github-pages.yml

@@ -0,0 +1,49 @@
+# GitHub Actions workflow for Baler (BAd Link reportER) version 2.0.4.
+# This is available as the file "sample-workflow.yml" from the source
+# code repository for Baler: https://github.com/caltechlibrary/baler
+
+name: Bad Link Reporter
+
+# Configure this section ─────────────────────────────────────────────
+
+env:
+  # Files to check. (Put patterns on separate lines, no leading dash.)
+  files: |
+    **/*.md
+
+  # Label assigned to issues created by this workflow:
+  labels: bug
+
+  # Number of previous issues to check for duplicate reports.
+  lookback: 10
+
+  # Time (sec) to wait on an unresponsive URL before trying once more.
+  timeout: 15
+
+  # Optional file containing a list of URLs to ignore, one per line:
+  ignore: .github/workflows/ignored-urls.txt
+
+on:
+  schedule:  # Cron syntax is: "min hr day-of-month month day-of-week"
+    - cron: 00 04 * * 1
+  push:
+    paths: ['**.md']
+  workflow_dispatch:
+
+# The rest of this file should be left as-is ─────────────────────────
+
+run-name: Test links in Markdown files
+jobs:
+  Baler:
+    name: Link checker and reporter
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - uses: caltechlibrary/baler@v2
+        with:
+          files:    ${{github.event.inputs.files    || env.files}}
+          labels:   ${{github.event.inputs.labels   || env.labels}}
+          ignore:   ${{github.event.inputs.ignore   || env.ignore}}
+          timeout:  ${{github.event.inputs.timeout  || env.timeout}}
+          lookback: ${{github.event.inputs.lookback || env.lookback}}

.github/workflows/bad-link-reporter.yml

@@ -0,0 +1,53 @@
+# Summary: GitHub Actions workflow to build IGA docs using MyST.
+#
+# This workflow file was originally based on work by GitHub user "peaceiris":
+# https://github.com/peaceiris/actions-gh-pages
+#
+# Copyright 2024 California Institute of Technology.
+# License: Modified BSD 3-clause – see file "LICENSE" in the project website.
+# Website: https://github.com/caltechlibrary/iga
+
+name: GitHub Pages builder & deployer
+
+on:
+  push:
+    branches: [main]
+    paths: [docs/**]
+
+jobs:
+  deploy:
+    name: Build and deploy docs
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Check out copy of git repository.
+        uses: actions/checkout@v4
+
+      - name: Set up Python.
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+          cache: pip
+
+      - name: Upgrade pip.
+        run: |
+          # install pip=>20.1 to use "pip cache dir"
+          python3 -m pip install --upgrade pip
+
+      - name: Install dependencies.
+        run: |
+          python3 -m pip install "myst-parser[linkify]"
+          python3 -m pip install sphinx-material
+          python3 -m pip install sphinxcontrib-mermaid
+
+      - name: Build Sphinx docs.
+        run: |
+          cd docs
+          make html
+
+      - name: Deploy.
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build/html