Merge branch 'main' into action-secrets

Author: sigmavirus24

.github/pull_request_template.md

@@ -12,7 +12,7 @@ Please provide:
 
 - The version of pip you used to install github3.py
 
-- The version of github3.py, requests, uritemplate, and dateutil installed
+- The version of github3.py, requests, uritemplate, and python-dateutil installed
 
 ## Minimum Reproducible Example
 

.github/workflows/docs.yml

@@ -0,0 +1,45 @@
+---
+name: Check documentation
+
+"on":
+  schedule:
+    - cron: "0 1 * * *" # everyday at 1am
+  push:
+    paths:
+      - "**.rst"
+      - "docs/**"
+  pull_request:
+    paths:
+      - "**.rst"
+      - "docs/**"
+
+jobs:
+  docs:
+    name: Build documentation & check links
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Upgrade pip
+        run: |
+          pip install -U pip
+          pip --version
+
+      - name: Install Tox
+        run: |
+          pip install tox
+          tox --version
+
+      - name: Build documentation
+        run: tox
+        env:
+          TOXENV: docs
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: docs/build

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
     - id: check-added-large-files
     - id: check-toml
@@ -13,31 +13,33 @@ repos:
     - id: trailing-whitespace
       types: [text]
       stages: [commit, push, manual]
-  - repo: https://github.com/asottile/reorder-python-imports
-    rev: v3.10.0
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
     hooks:
-    - id: reorder-python-imports
-      args: [--application-directories, '.:src', --py37-plus]
+    - id: isort
   - repo: https://github.com/psf/black
-    rev: 23.3.0
+    rev: 24.4.0
     hooks:
     - id: black
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.7.0
+    rev: v3.15.2
     hooks:
     - id: pyupgrade
       args: [--py37-plus]
-  #- repo: https://github.com/pre-commit/mirrors-mypy
-  #  rev: v0.910
-  #  hooks:
-  #  - id: mypy
-  #    exclude: ^(docs/|tests/)
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+    - id: mypy
+      additional_dependencies:
+      - types-python-dateutil
+      - types-requests
+      exclude: ^(docs/|tests/)
   - repo: https://github.com/jorisroovers/gitlint
     rev: v0.19.1
     hooks:
     - id: gitlint
   - repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v2.3.0
+    rev: v2.5.0
     hooks:
     - id: setup-cfg-fmt
       args: [--min-py3-version, '3.7']

.readthedocs.yml

@@ -0,0 +1,12 @@
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+sphinx:
+  configuration: docs/source/conf.py
+formats: all
+python:
+  install:
+    - requirements: docs/source/requirements.txt
+    - path: .

AUTHORS.rst

@@ -224,3 +224,5 @@ Contributors
 - Chris R (@offbyone)
 
 - Thomas Buchner (@MrBatschner)
+
+- Chris Cotter (@ccotter)

docs/source/requirements.txt

@@ -1,2 +1,3 @@
 sphinx>=4.2.0
 docutils!=0.18
+sphinx_rtd_theme

pyproject.toml

@@ -70,7 +70,6 @@ Source = "https://github.com/sigmavirus24/github3.py"
 [tool.black]
 line-length = 78
 target-version = ['py37']
-safe = true
 exclude = '''
 (
   /(
@@ -83,6 +82,19 @@ exclude = '''
     | _build
     | build
     | dist
+    | venv
   )/
 )
 '''
+
+[tool.mypy]
+files = ["."]
+exclude = [
+    "^docs/",
+    "^tests/",
+]
+
+[tool.isort]
+profile = "black"
+line_length = 78
+force_single_line = true

src/github3/__about__.py

@@ -1,4 +1,5 @@
 """The module that holds much of the metadata about github3.py."""
+
 __package_name__ = "github3.py"
 __title__ = "github3"
 __author__ = "Ian Stapleton Cordasco"

src/github3/__init__.py

@@ -8,6 +8,7 @@
 :license: Modified BSD, see LICENSE for more details
 
 """
+
 from .__about__ import __author__
 from .__about__ import __author_email__
 from .__about__ import __copyright__

src/github3/api.py

@@ -6,6 +6,7 @@
 :license: Modified BSD, see LICENSE for more details
 
 """
+
 from .github import GitHub
 from .github import GitHubEnterprise