dev: update the Dockerfile and pre-commit configuration

Also, * Reverted whitespace changes for files under the `.github/` directory, * Rebase `.gitignore` to GitHub's `Python.gitignore`, * Remove VS Code-specific configuration, and * Update the `pyproject.toml` to use PEP 521 names.
vipyrsec · Oct 6, 2024 · f3ec968 · f3ec968
1 parent 7008ac1
commit f3ec968
Show file tree

Hide file tree

Showing 16 changed files with 662 additions and 737 deletions.
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -1,33 +1,35 @@
+---
 version: 2
+
 updates:
-- package-ecosystem: "devcontainers"
-  directory: "/"
-  schedule:
-    interval: "monthly"
+  - package-ecosystem: devcontainers
+    directory: /
+    schedule:
+      interval: monthly
 
-- package-ecosystem: "github-actions"
-  directory: "/"
-  schedule:
-    interval: "monthly"
-  groups:
-    ci-dependencies:
-      patterns:
-      - "*"
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      ci-dependencies:
+        patterns:
+          - '*'
 
-- package-ecosystem: "pip"
-  directory: "/"
-  schedule:
-    interval: "monthly"
-  groups:
-    python-dependencies:
-      patterns:
-      - "*"
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      python-dependencies:
+        patterns:
+          - '*'
 
-- package-ecosystem: "docker"
-  directory: "/"
-  schedule:
-    interval: "monthly"
-  groups:
-    docker-dependencies:
-      patterns:
-      - "*"
+  - package-ecosystem: docker
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      docker-dependencies:
+        patterns:
+          - '*'
diff --git a/.github/workflows/container-build-push.yaml b/.github/workflows/container-build-push.yaml
@@ -4,9 +4,9 @@ name: Container Build and Push
 on:
   push:
     branches:
-    - main
+      - main
     tags:
-    - v*
+      - v*
   pull_request:
 
 defaults:

diff --git a/.github/workflows/dependency-review.yaml b/.github/workflows/dependency-review.yaml
@@ -1,4 +1,5 @@
-name: "Dependency Review"
+---
+name: Dependency Review
 
 on:
   pull_request:
@@ -11,10 +12,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: "Checkout Repository"
-      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11   # v4.1.1
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11  # v4.1.1
 
-    - name: "Dependency Review"
-      uses: actions/dependency-review-action@9129d7d40b8c12c1ed0f60400d00c92d437adcce   # v4.1.3
-      with:
-        config-file: darbiadev/.github/.github/dependency-review-config.yaml@f185cc076161b47921c6fb6da4c1fd5e40b50bff   # v3.0.0
+      - name: Dependency Review
+        uses: actions/dependency-review-action@9129d7d40b8c12c1ed0f60400d00c92d437adcce  # v4.1.3
+        with:
+          config-file: darbiadev/.github/.github/dependency-review-config.yaml@f185cc076161b47921c6fb6da4c1fd5e40b50bff  # v3.0.0
diff --git a/.github/workflows/python-ci.yaml b/.github/workflows/python-ci.yaml
@@ -1,31 +1,34 @@
-name: "Python CI"
+---
+name: Python CI
 
 on:
   push:
     branches:
-    - main
+      - main
   pull_request:
 
 jobs:
   pre-commit:
-    uses: darbiadev/.github/.github/workflows/generic-precommit.yaml@ea97d99e1520c46080c4c9032a69552e491474ac # v13.0.0
+    uses: darbiadev/.github/.github/workflows/generic-precommit.yaml@ea97d99e1520c46080c4c9032a69552e491474ac  # v13.0.0
     with:
-      python-version: "3.11"
+      python-version: '3.11'
 
   lint:
     needs: pre-commit
-    uses: darbiadev/.github/.github/workflows/python-lint.yaml@6a6eb74ae11149881c29adf5a5f7af23349c8762 # v9.0.0
+    uses: darbiadev/.github/.github/workflows/python-lint.yaml@6a6eb74ae11149881c29adf5a5f7af23349c8762  # v9.0.0
     with:
-      python-version: "3.11"
+      python-version: '3.11'
 
   test:
     needs: lint
     strategy:
       matrix:
-        os: [ubuntu-latest]
-        python-version: ["3.11"]
+        os:
+          - ubuntu-latest
+        python-version:
+          - '3.11'
 
-    uses: darbiadev/.github/.github/workflows/python-test.yaml@ea97d99e1520c46080c4c9032a69552e491474ac # v13.0.0
+    uses: darbiadev/.github/.github/workflows/python-test.yaml@ea97d99e1520c46080c4c9032a69552e491474ac  # v13.0.0
     with:
       os: ${{ matrix.os }}
       python-version: ${{ matrix.python-version }}
@@ -37,6 +40,6 @@ jobs:
       pages: write
       id-token: write
 
-    uses: darbiadev/.github/.github/workflows/github-pages-python-sphinx.yaml@ea97d99e1520c46080c4c9032a69552e491474ac # v13.0.0
+    uses: darbiadev/.github/.github/workflows/github-pages-python-sphinx.yaml@ea97d99e1520c46080c4c9032a69552e491474ac  # v13.0.0
     with:
-      python-version: "3.11"
+      python-version: '3.11'
diff --git a/.github/workflows/sentry-release.yaml b/.github/workflows/sentry-release.yaml
@@ -1,23 +1,23 @@
-name: "Sentry release"
+---
+name: Sentry release
 
 on:
   push:
     branches:
-    - main
+      - main
 
 jobs:
   sentry-release:
     runs-on: ubuntu-latest
 
     steps:
-    - name: "Checkout repository"
-      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11   # v4.1.1
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11  # v4.1.1
 
-    - name: "Create Sentry release"
-      uses: getsentry/action-release@e769183448303de84c5a06aaaddf9da7be26d6c7   # v1.7.0
-      env:
-        SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
-        SENTRY_ORG: ${{ vars.SENTRY_ORG }}
-        SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
-      with:
-        version_prefix: "${{ vars.SENTRY_PROJECT }}@"
+      - name: Create Sentry release
+        uses: getsentry/action-release@e769183448303de84c5a06aaaddf9da7be26d6c7  # v1.7.0
+        env:
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          SENTRY_ORG: ${{ vars.SENTRY_ORG }}
+          SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
+        with:
+          version_prefix: ${{ vars.SENTRY_PROJECT }}@
diff --git a/.gitignore b/.gitignore
@@ -20,19 +20,12 @@ parts/
 sdist/
 var/
 wheels/
-pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
 MANIFEST
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
@@ -50,30 +43,15 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+cover/
 
 # Translations
 *.mo
 *.pot
 
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
 # Sphinx documentation
 docs/_build/
 
-# PyBuilder
-target/
-
 # Jupyter Notebook
 .ipynb_checkpoints
 
@@ -82,25 +60,23 @@ profile_default/
 ipython_config.py
 
 # pyenv
-.python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
 
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
 __pypackages__/
 
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
 # Environments
 .env
 .venv
@@ -125,10 +101,9 @@ venv.bak/
 .dmypy.json
 dmypy.json
 
-# Pyre type checker
-.pyre/
-
-# JetBrains IDEs
-/.idea
-
-.pdm-python
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,5 @@
+---
+MD013:
+  line_length: 120
+
+MD024: false