Merge 335031e into f266706

domdfcoding · Apr 25, 2024 · 2bd7406 · 2bd7406
2 parents f266706 + 335031e
commit 2bd7406
Show file tree

Hide file tree

Showing 17 changed files with 93 additions and 85 deletions.
diff --git a/.dependabot/config.yml b/.dependabot/config.yml
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,5 +6,6 @@ updates:
   directory: /
   schedule:
     interval: weekly
+  open-pull-requests-limit: 0
   reviewers:
   - domdfcoding
diff --git a/.github/workflows/docs_test_action.yml b/.github/workflows/docs_test_action.yml
@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: Check for changed files
         uses: dorny/paths-filter@v2

diff --git a/.github/workflows/flake8.yml b/.github/workflows/flake8.yml
@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Checkout 🛎️
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: Check for changed files
         uses: dorny/paths-filter@v2
@@ -33,7 +33,7 @@ jobs:
 
       - name: Setup Python 🐍
         if: steps.changes.outputs.code == 'true'
-        uses: "actions/setup-python@v4"
+        uses: "actions/setup-python@v5"
         with:
           python-version: "3.8"
 

diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml
@@ -25,7 +25,7 @@ jobs:
 
     steps:
       - name: Checkout 🛎️
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: Check for changed files
         uses: dorny/paths-filter@v2
@@ -38,7 +38,7 @@ jobs:
 
       - name: Setup Python 🐍
         if: steps.changes.outputs.code == 'true'
-        uses: "actions/setup-python@v4"
+        uses: "actions/setup-python@v5"
         with:
           python-version: "3.8"
 

diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml
@@ -34,13 +34,13 @@ jobs:
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
           - {python-version: "3.10", testenvs: "py310,build", experimental: False}
           - {python-version: "3.11", testenvs: "py311-dev,build", experimental: True}
-          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
-          - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: True}
-          - {python-version: "pypy-3.9", testenvs: "pypy39", experimental: True}
+          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: False}
+          - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: False}
+          - {python-version: "pypy-3.9", testenvs: "pypy39,build", experimental: True}
 
     steps:
       - name: Checkout 🛎️
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: Check for changed files
         if: startsWith(github.ref, 'refs/tags/') != true
@@ -55,7 +55,7 @@ jobs:
       - name: Setup Python 🐍
         id: setup-python
         if: ${{ steps.changes.outputs.code == 'true' || steps.changes.outcome == 'skipped' }}
-        uses: "actions/setup-python@v4"
+        uses: "actions/setup-python@v5"
         with:
           python-version: "${{ matrix.config.python-version }}"
 
@@ -72,7 +72,7 @@ jobs:
         run: python -m tox -e "${{ matrix.config.testenvs }}" -s false
 
       - name: "Upload Coverage 🚀"
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: ${{ always() && steps.setup-python.outcome == 'success' }}
         with:
           name: "coverage-${{ matrix.config.python-version }}"

diff --git a/.github/workflows/python_ci_linux.yml b/.github/workflows/python_ci_linux.yml
@@ -35,13 +35,13 @@ jobs:
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
           - {python-version: "3.10", testenvs: "py310,build", experimental: False}
           - {python-version: "3.11", testenvs: "py311-dev,build", experimental: True}
-          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
-          - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: True}
-          - {python-version: "pypy-3.9", testenvs: "pypy39", experimental: True}
+          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: False}
+          - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: False}
+          - {python-version: "pypy-3.9", testenvs: "pypy39,build", experimental: True}
 
     steps:
       - name: Checkout 🛎️
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: Check for changed files
         if: startsWith(github.ref, 'refs/tags/') != true
@@ -56,7 +56,7 @@ jobs:
       - name: Setup Python 🐍
         id: setup-python
         if: ${{ steps.changes.outputs.code == 'true' || steps.changes.outcome == 'skipped' }}
-        uses: "actions/setup-python@v4"
+        uses: "actions/setup-python@v5"
         with:
           python-version: "${{ matrix.config.python-version }}"
 
@@ -74,7 +74,7 @@ jobs:
         run: python -m tox -e "${{ matrix.config.testenvs }}" -s false
 
       - name: "Upload Coverage 🚀"
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: ${{ always() && steps.setup-python.outcome == 'success' }}
         with:
           name: "coverage-${{ matrix.config.python-version }}"
@@ -86,10 +86,10 @@ jobs:
     runs-on: "ubuntu-20.04"
     steps:
       - name: Checkout 🛎️
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: Setup Python 🐍
-        uses: "actions/setup-python@v4"
+        uses: "actions/setup-python@v5"
         with:
           python-version: 3.8
 
@@ -99,7 +99,7 @@ jobs:
           python -m pip install --upgrade "coveralls>=3.0.0" coverage_pyver_pragma
 
       - name: "Download Coverage 🪂"
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: coverage
 
@@ -117,7 +117,7 @@ jobs:
 
       - name: "Upload Combined Coverage Artefact 🚀"
         if: ${{ steps.show.outcome != 'failure' }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: "combined-coverage"
           path: .coverage
@@ -135,11 +135,11 @@ jobs:
     runs-on: "ubuntu-20.04"
     steps:
       - name: Checkout 🛎️
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
         if: startsWith(github.ref, 'refs/tags/')
 
       - name: Setup Python 🐍
-        uses: "actions/setup-python@v4"
+        uses: "actions/setup-python@v5"
         if: startsWith(github.ref, 'refs/tags/')
         with:
           python-version: 3.8

diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml
@@ -18,8 +18,8 @@ permissions:
 
 jobs:
   tests:
-    name: "macos-latest / Python ${{ matrix.config.python-version }}"
-    runs-on: "macos-latest"
+    name: "macos-13 / Python ${{ matrix.config.python-version }}"
+    runs-on: "macos-13"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
       USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11,pypy-3.7,pypy-3.8,pypy-3.9'
@@ -34,13 +34,13 @@ jobs:
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
           - {python-version: "3.10", testenvs: "py310,build", experimental: False}
           - {python-version: "3.11", testenvs: "py311-dev,build", experimental: True}
-          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: True}
-          - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: True}
-          - {python-version: "pypy-3.9", testenvs: "pypy39", experimental: True}
+          - {python-version: "pypy-3.7", testenvs: "pypy37,build", experimental: False}
+          - {python-version: "pypy-3.8", testenvs: "pypy38,build", experimental: False}
+          - {python-version: "pypy-3.9", testenvs: "pypy39,build", experimental: True}
 
     steps:
       - name: Checkout 🛎️
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: Check for changed files
         if: startsWith(github.ref, 'refs/tags/') != true
@@ -55,7 +55,7 @@ jobs:
       - name: Setup Python 🐍
         id: setup-python
         if: ${{ steps.changes.outputs.code == 'true' || steps.changes.outcome == 'skipped' }}
-        uses: "actions/setup-python@v4"
+        uses: "actions/setup-python@v5"
         with:
           python-version: "${{ matrix.config.python-version }}"
 
@@ -72,7 +72,7 @@ jobs:
         run: python -m tox -e "${{ matrix.config.testenvs }}" -s false
 
       - name: "Upload Coverage 🚀"
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: ${{ always() && steps.setup-python.outcome == 'success' }}
         with:
           name: "coverage-${{ matrix.config.python-version }}"

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,7 +8,7 @@ ci:
 
 repos:
  - repo: https://github.com/repo-helper/pyproject-parser
-   rev: v0.7.0
+   rev: v0.11.0
    hooks:
     - id: reformat-pyproject
 
@@ -43,13 +43,13 @@ repos:
     - id: bind-requirements
 
  - repo: https://github.com/domdfcoding/flake8-dunder-all
-   rev: v0.2.2
+   rev: v0.4.1
    hooks:
     - id: ensure-dunder-all
       files: ^octo_api/.*\.py$
 
  - repo: https://github.com/domdfcoding/flake2lint
-   rev: v0.4.2
+   rev: v0.4.3
    hooks:
     - id: flake2lint
 
@@ -76,18 +76,18 @@ repos:
     - id: forbid-crlf
 
  - repo: https://github.com/python-formate/snippet-fmt
-   rev: v0.1.4
+   rev: v0.1.5
    hooks:
     - id: snippet-fmt
 
  - repo: https://github.com/python-formate/formate
-   rev: v0.4.10
+   rev: v0.7.0
    hooks:
     - id: formate
       exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$
 
  - repo: https://github.com/domdfcoding/dep_checker
-   rev: v0.7.1
+   rev: v0.8.0
    hooks:
     - id: dep_checker
       args:

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -9,9 +9,16 @@ formats:
  - pdf
  - htmlzip
 python:
-  version: 3.8
   install:
    - requirements: requirements.txt
    - requirements: doc-source/requirements.txt
-   - method: pip
-     path: .
+build:
+  os: ubuntu-20.04
+  tools:
+    python: '3.9'
+  jobs:
+    post_create_environment:
+     - pip install .
+    post_install:
+     - pip install sphinxcontrib-applehelp==1.0.4 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-htmlhelp==2.0.1
+       sphinxcontrib-jsmath==1.0.1 sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.5
diff --git a/README.rst b/README.rst
@@ -99,7 +99,7 @@ octo-api
 	:target: https://github.com/domdfcoding/octo-api/commit/master
 	:alt: GitHub last commit
 
-.. |maintained| image:: https://img.shields.io/maintenance/yes/2023
+.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
 	:alt: Maintenance
 
 .. |pypi-downloads| image:: https://img.shields.io/pypi/dm/octo-api

diff --git a/doc-source/conf.py b/doc-source/conf.py
@@ -69,5 +69,11 @@
 def setup(app):
 	# 3rd party
 	from sphinx_toolbox.latex import better_header_layout
+	from sphinxemoji import sphinxemoji
 
 	app.connect("config-inited", lambda app, config: better_header_layout(config))
+	app.connect("build-finished", sphinxemoji.copy_asset_files)
+	app.add_js_file("https://unpkg.com/twemoji@latest/dist/twemoji.min.js")
+	app.add_js_file("twemoji.js")
+	app.add_css_file("twemoji.css")
+	app.add_transform(sphinxemoji.EmojiSubstitutions)
diff --git a/doc-source/index.rst b/doc-source/index.rst
@@ -104,7 +104,7 @@ octo-api
 		:last-commit:
 		:alt: GitHub last commit
 
-	.. |maintained| maintained-shield:: 2023
+	.. |maintained| maintained-shield:: 2024
 		:alt: Maintenance
 
 	.. |pypi-downloads| pypi-shield::

diff --git a/doc-source/requirements.txt b/doc-source/requirements.txt
@@ -1,17 +1,17 @@
-default-values>=0.5.0
+default-values>=0.6.0
 domdf-sphinx-theme>=0.3.0
-extras-require>=0.2.0
-html-section>=0.1.0
-seed-intersphinx-mapping>=0.3.1
+extras-require>=0.5.0
+html-section>=0.3.0
+seed-intersphinx-mapping>=1.2.2
 sphinx<3.4.0,>=3.0.3
 sphinx-copybutton>=0.2.12
-sphinx-debuginfo>=0.1.0
-sphinx-licenseinfo>=0.1.1
+sphinx-debuginfo>=0.2.2
+sphinx-licenseinfo>=0.3.1
 sphinx-notfound-page>=0.7.1
 sphinx-prompt>=1.1.0
 sphinx-pyproject>=0.1.0
 sphinx-tabs>=1.1.13
-sphinx-toolbox>=2.13.0
+sphinx-toolbox>=3.5.0
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
-toctree-plus>=0.5.0
+toctree-plus>=0.6.1
diff --git a/formate.toml b/formate.toml
@@ -6,21 +6,17 @@ noqa-reformat = 60
 ellipsis-reformat = 70
 squish_stubs = 80
 
-[config]
-indent = "\t"
-line_length = 115
-
 [hooks.yapf]
 priority = 30
 
-[hooks.isort]
-priority = 50
-
 [hooks.yapf.kwargs]
 yapf_style = ".style.yapf"
 
+[hooks.isort]
+priority = 50
+
 [hooks.isort.kwargs]
-indent = "\t\t"
+indent = "		"
 multi_line_output = 8
 import_heading_stdlib = "stdlib"
 import_heading_thirdparty = "3rd party"
@@ -54,4 +50,8 @@ known_third_party = [
     "requests",
     "typing_extensions",
 ]
-known_first_party = "octo_api"
+known_first_party = [ "octo_api",]
+
+[config]
+indent = "	"
+line_length = 115