Merge branch 'main' into add-data-section-to-guide

Author: lwasser

.all-contributorsrc

@@ -1,10 +1,16 @@
 version: 2.1
 jobs:
-  build_book:
+  build-book:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.13
     steps:
       - checkout
+      - run:
+          name: Restore mtimes from git history
+          command: |
+            sudo apt-get update
+            sudo apt-get install git-restore-mtime
+            git restore-mtime
       - run:
           name: setup environment
           command: |
@@ -22,6 +28,6 @@ jobs:
 # Tell CircleCI to use this workflow when it builds the site
 workflows:
   version: 2
-  build_book:
+  build-book:
     jobs:
-      - build_book
+      - build-book

.circleci/config.yml

@@ -0,0 +1,45 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    insecure-external-code-execution: allow
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 100
+    labels:
+      - "maintenance"
+      - "dependencies"
+    groups:
+      pip:
+        patterns:
+          - "*"
+    commit-message:
+      prefix: "chore"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 100
+    labels:
+      - "maintenance"
+      - "dependencies"
+    groups:
+      actions:
+        patterns:
+          - "*"
+    commit-message:
+      prefix: "chore"
+  - package-ecosystem: "github-actions"
+    directory: "examples/pure-hatch/.github/workflows"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 100
+    labels:
+      - "maintenance"
+      - "dependencies"
+    groups:
+      actions:
+        patterns:
+          - "*"
+    commit-message:
+      prefix: "chore"

.github/dependabot.yml

@@ -1,18 +1,25 @@
-name: Book Preview
-
+name: Book Preview Redirect
 on: [status]
 
+concurrency:
+  group: docs-preview-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   circleci_artifacts_redirector_job:
     runs-on: ubuntu-latest
-    if: "${{ github.event.context == 'ci/circleci: build_book' }}"
+    # For testing this action on a fork, remove the "github.repository =="" condition.
+    if: "github.event.context == 'ci/circleci: build-book'"
+    permissions:
+      statuses: write
     name: Run CircleCI artifacts redirector
     steps:
       - name: GitHub Action step
         id: step1
         uses: larsoner/circleci-artifacts-redirector-action@master
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
+          api-token: ${{ secrets.CIRCLECI_TOKEN }}
           artifact-path: 0/html/index.html
-          circleci-jobs: build_book
-          job-title: Click to preview rendered book
+          circleci-jobs: build-book
+          job-title: View rendered book here!

.github/workflows/artifact_redirect.yml

@@ -1,7 +1,7 @@
 name: build-test-deploy-book
 
 # Only build PRs, the main branch, and releases. Pushes to branches will only
-# be built when a PR is opened. This avoids duplicated buids in PRs coming
+# be built when a PR is opened. This avoids duplicated builds in PRs coming
 # from branches in the origin repository (1 for PR and 1 for push).
 # This came from Leo's work with fatiando
 on:
@@ -15,57 +15,64 @@ jobs:
   build-test-book:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
+        with:
+          fetch_depth: 0
 
-    - name: Setup Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.9'
+      - name: Restore mtimes from git history
+        run: |
+          sudo apt-get install git-restore-mtime
+          git restore-mtime
 
-    - name: Upgrade pip
-      run: |
-        # install pip=>20.1 to use "pip cache dir"
-        python3 -m pip install --upgrade pip
-    - name: Get pip cache dir
-      id: pip-cache
-      run: echo "::set-output name=dir::$(pip cache dir)"
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
 
-    - name: Cache dependencies
-      uses: actions/cache@v2
-      with:
-        path: ${{ steps.pip-cache.outputs.dir }}
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
+      - name: Upgrade pip
+        run: |
+          # install pip=>20.1 to use "pip cache dir"
+          python3 -m pip install --upgrade pip
+      - name: Get pip cache dir
+        id: pip-cache
+        run: echo "::set-output name=dir::$(pip cache dir)"
 
-    - name: Install dependencies
-      run: python3 -m pip install nox
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
 
-    - name: Build book
-      run: nox -s docs
+      - name: Install dependencies
+        run: python3 -m pip install nox
 
-    # Save html as artifact
-    - name: Save book html as artifact for viewing
-      uses: actions/upload-artifact@v3
-      with:
-        name: book-html
-        path: |
-          _build/html/
+      - name: Build book
+        run: nox -s docs-test
 
-    # Push the book's HTML to github-pages
-    - name: Push to GitHub Pages
-      # Only push if on main branch
-      if: github.ref == 'refs/heads/main'
-      uses: peaceiris/[email protected]
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./_build/html
+      # Save html as artifact
+      - name: Save book html as artifact for viewing
+        uses: actions/upload-artifact@v4
+        with:
+          name: book-html
+          path: |
+            _build/html/
 
-    # Test for bad links and ensure alt tags for usability
-    - name: Check HTML using htmlproofer
-      uses: chabad360/htmlproofer@master
-      with:
-        directory: '_build/html'
-        arguments: |
-          --ignore-files "/.+\/_static\/.+/,/genindex.html/"
-          --ignore-status-codes "404, 403, 503"
+      # Push the book's HTML to github-pages
+      - name: Push to GitHub Pages
+        # Only push if on main branch
+        if: github.ref == 'refs/heads/main'
+        uses: peaceiris/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./_build/html
+
+      # Test for bad links and ensure alt tags for usability
+      - name: Check HTML using htmlproofer
+        uses: chabad360/htmlproofer@master
+        with:
+          directory: "_build/html"
+          arguments: |
+            --ignore-files "/.+\/_static\/.+/,/genindex.html/"
+            --ignore-status-codes "0, 200, 403, 429, 503"

.github/workflows/build-book.yml

@@ -0,0 +1,28 @@
+name: Crowdin Sync
+
+on:
+  workflow_dispatch:
+
+jobs:
+  sync-translations:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v5
+
+      - name: Sync with Crowdin
+        uses: crowdin/github-action@v2
+        with:
+          upload_sources: true
+          upload_translations: false
+          download_translations: true
+          localization_branch_name: l10n_crowdin_translations
+          create_pull_request: true
+          pull_request_title: "Crowdin: New translations"
+          pull_request_body: "Crowdin synced updated translations via GitHub Action."
+          pull_request_base_branch_name: "main"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN_CROWDIN }}
+          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

.github/workflows/crowdin_sync.yml

@@ -0,0 +1,20 @@
+name: Add help-wanted issues to help wanted board
+
+on:
+  issues:
+    types:
+      - labeled
+
+jobs:
+  add-help-wanted:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Add issue to project
+        id: add-to-project
+        uses: actions/[email protected]
+        with:
+          project-url: https://github.com/orgs/pyOpenSci/projects/3
+          # This is a organization level token so it can be used across all repos in our org
+          github-token: ${{ secrets.GHPROJECT_HELP_WANTED }}
+          labeled: help wanted, sprintable
+          label-operator: OR

.github/workflows/main.yml

@@ -1,9 +1,32 @@
-_build
-.vscode
-*/.ipynb_checkpoints/*
+# Vscode
+.vscode/
+
+# Python
 tmp/
 .DS_Store
-.nox
-__pycache__
 *notes-from-review.md
 *.idea*
+# Grammar / syntax checkers
+styles/
+# Exclude translation .mo files
+locales/*/LC_MESSAGES/*.mo
+
+# Exclude Jupyter Notebook checkpoints
+.ipynb_checkpoints/
+*/.ipynb_checkpoints/*
+
+# Exclude Python bytecode
+__pycache__/
+
+# Exclude build directories
+_build/
+
+# Exclude virtual environments
+venv/
+env/
+ENV/
+.venv/
+.ENV/
+*/venv/
+.nox
+*/.nox/

.gitignore

@@ -12,10 +12,9 @@
 # - Register git hooks: pre-commit install --install-hooks
 
 repos:
-
   # Misc commit checks
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v6.0.0
     # ref: https://github.com/pre-commit/pre-commit-hooks#hooks-available
     hooks:
       # Autoformat: Makes sure files end in a newline and only a newline.
@@ -26,16 +25,31 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.5
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+        exclude: >
+          (?x)^(
+              (.*vale-styles.*)|(.*\.po)
+          )$
+
+  - repo: https://github.com/errata-ai/vale
+    rev: v3.12.0
+    hooks:
+      - id: vale
+
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: v3.6.2
     hooks:
-    - id: codespell
-      additional_dependencies:
-        - tomli
+      - id: prettier
+        types_or: [yaml, html, css, scss, javascript, json, toml]
 
 ci:
-    autofix_prs: false
-    #skip: [flake8, end-of-file-fixer]
-    autofix_commit_msg: |
-        '[pre-commit.ci 🤖] Apply code format tools to PR'
-    # Update hook versions every month (so we don't get hit with weekly update pr's)
-    autoupdate_schedule: monthly
+  autofix_prs: false
+  #skip: [flake8, end-of-file-fixer]
+  autofix_commit_msg: |
+    '[pre-commit.ci 🤖] Apply code format tools to PR'
+  # Update hook versions every month (so we don't get hit with weekly update pr's)
+  autoupdate_schedule: monthly

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+# Configuration file for using Vale in the python-package-guide repository
+#
+# To disable checks on parts of a MarkDown or HTML file, delimit the section
+# using these HTML comments:
+#     to disabled Vale checks after this line: <!-- vale off -->
+#     to enable Vale checks after this line: <!-- vale on -->
+#
+# To disable checks based on MarkDown scope, see IgnoredScopes.
+# To disable checks on certain HTML elements, see IgnoredClasses.
+#
+# More information about the configuration can be found here:
+# https://vale.sh/docs/topics/config
+
+
+# Path to the styles directory, where style rules are defined
+StylesPath = vale-styles
+
+# Path to a dictionary folders inside the StylesPath config subdirectory. This
+# folder can contain two files, accept.txt and reject.txt, with one word per
+# line. These words will be used to check for spelling mistakes in addition to
+# the internal dictionary, if the 'Vale' ruleset is enabled (see below)
+# See https://vale.sh/docs/topics/vocab/#folder-structure for more details
+Vocab = sample
+
+
+# Checks are defined in sections by file type, like the one below for
+# MarkDown. In each section you can enable groups of style rules, defined in folders
+# inside the StylesPath directory.
+# Use 'Vale' to enable the internal style rules and checks.
+
+[*.md]
+BasedOnStyles = package-guide-test