Test

.github/dependabot.yml

@@ -1,22 +1,30 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for more information:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://containers.dev/guide/dependabot
+
 version: 2
 updates:
-- package-ecosystem: pip
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "13:00"
-  open-pull-requests-limit: 10
-  reviewers:
-  - dciborow
-  allow:
-  - dependency-type: direct
-  - dependency-type: indirect
-  commit-message:
-    prefix: "fix: "
-- package-ecosystem: "github-actions"
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "13:00"
-  commit-message:
-    prefix: "fix: "
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
+    reviewers:
+      - RedNoodlesOrg/python-team
+    allow:
+      - dependency-type: direct
+      - dependency-type: indirect
+    commit-message:
+      prefix: "fix: "
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: weekly
+      time: "13:00"
+    commit-message:
+      prefix: "fix: "
+    open-pull-requests-limit: 10
+    reviewers:
+      - RedNoodlesOrg/actions-team

.github/workflows/pull-request.yml

@@ -0,0 +1,29 @@
+name: Check pull request
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+    branches: main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+
+      - name: Setup PDM
+        id: pdm_setup
+        uses: pdm-project/[email protected]
+        with:
+          python-version-file: "pyproject.toml"
+      - name: Install dependencies
+        run: pdm install --group dev
+
+      - name: Cache pre-commit
+        uses: actions/[email protected]
+        with:
+          path: ~/.cache/pre-commit
+          key: ${{ runner.os }}-precommit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files

.github/workflows/sphinx.yml

@@ -2,17 +2,53 @@ name: Deploy Sphinx documentation to Pages
 
 on:
   push:
-    branches: [main] # branch to trigger deployment
+    branches: [main]
 
 jobs:
   pages:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     permissions:
       pages: write
       id-token: write
     steps:
-    - id: deployment
-      uses: sphinx-notes/pages@v3
+      - uses: actions/[email protected]
+
+      - name: Setup PDM
+        id: pdm_setup
+        uses: pdm-project/[email protected]
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install dependencies
+        run: pdm install --group docs
+
+      - name: Read pyproject.toml
+        run: |
+          echo "PROJECT_VERSION=$(yq eval '.project.version' pyproject.toml)" >> $GITHUB_ENV
+          echo "PROJECT_AUTHOR=$(yq eval '.project.authors[0].name' pyproject.toml)" >> $GITHUB_ENV
+          echo "PROJECT_NAME=$(yq eval '.project.name' pyproject.toml)" >> $GITHUB_ENV
+          echo "SPHINX_THEME=$(yq eval '.tool.project-customizations.docs.theme' pyproject.toml)" >> $GITHUB_ENV
+
+      - name: Create docs
+        run: |
+          pdm run sphinx-apidoc --full \
+            --ext-githubpages \
+            --ext-viewcode \
+            --ext-ifconfig \
+            --ext-todo \
+            --ext-autodoc \
+            --ext-intersphinx \
+            -H $PROJECT_NAME \
+            -A $PROJECT_AUTHOR \
+            -V $PROJECT_VERSION \
+            -o docs src/*/
+
+      - id: deployment
+        uses: sphinx-notes/pages@v3
+        with:
+          python_version: ${{ steps.pdm_setup.outputs.python-version }}
+          checkout: false
+          sphinx_build_options: -D html_theme=${{ env.SPHINX_THEME }}

.gitignore

@@ -20,7 +20,6 @@ parts/
 sdist/
 var/
 wheels/
-pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
@@ -50,6 +49,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+cover/
 
 # Translations
 *.mo
@@ -72,6 +72,7 @@ instance/
 docs/_build/
 
 # PyBuilder
+.pybuilder/
 target/
 
 # Jupyter Notebook
@@ -82,7 +83,9 @@ profile_default/
 ipython_config.py
 
 # pyenv
-.python-version
+#   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
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -91,7 +94,24 @@ ipython_config.py
 #   install all needed dependencies.
 #Pipfile.lock
 
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# 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-project.org/#use-with-ide
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
 __pypackages__/
 
 # Celery stuff
@@ -127,3 +147,16 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# 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/