Switch to isort from reorder-python-imports

* chore: switch to isort from reorder python imports

- [x] keep it simple with just `--profile black` argument
- [x] update pull_request_template when asking for python-dateutil version
  - some engineers don't know to prefix `dateutil` with `python-`

This is a premptive strike on #1172 fix

Signed-off-by: jmeridth <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: add line-length to isort to match black

re-run black, hopefully get us to a non-conflict

Signed-off-by: jmeridth <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Use isort config to reduce churn

---------

Signed-off-by: jmeridth <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Ian Stapleton Cordasco <[email protected]>

.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
 

.pre-commit-config.yaml

@@ -13,11 +13,10 @@ repos:
     - id: trailing-whitespace
       types: [text]
       stages: [commit, push, manual]
-  - repo: https://github.com/asottile/reorder-python-imports
-    rev: v3.12.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.12.1
     hooks:

pyproject.toml

@@ -93,3 +93,8 @@ 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
 

src/github3/apps.py

@@ -2,6 +2,7 @@
 
 https://developer.github.com/apps/building-github-apps/
 """
+
 import time
 
 import jwt

src/github3/auths.py

@@ -1,4 +1,5 @@
 """This module contains the Authorization object."""
+
 from .decorators import requires_basic_auth
 from .models import GitHubCore
 

src/github3/checks.py

@@ -1,4 +1,5 @@
 """This module contains all the classes relating to Checks."""
+
 from json import dumps
 
 from . import decorators

src/github3/decorators.py

@@ -1,4 +1,5 @@
 """This module provides decorators to the rest of the library."""
+
 import os
 from functools import wraps
 from io import BytesIO as StringIO

src/github3/events.py

@@ -1,4 +1,5 @@
 """This module contains the classes related to Events."""
+
 import copy
 
 from . import models

src/github3/gists/__init__.py

@@ -12,6 +12,7 @@
 
 See also: http://developer.github.com/v3/gists/
 """
+
 from .gist import Gist
 from .gist import ShortGist
 

src/github3/gists/comment.py

@@ -1,4 +1,5 @@
 """Module containing the logic for a GistComment."""
+
 from .. import decorators
 from .. import models
 from .. import users

src/github3/gists/file.py

@@ -1,4 +1,5 @@
 """Module containing the GistFile object."""
+
 from .. import models
 
 

src/github3/gists/gist.py

@@ -1,13 +1,14 @@
 """This module contains the Gist, ShortGist, and GistFork objects."""
+
 import typing as t
 from json import dumps
 
-from . import comment
-from . import file as gistfile
-from . import history
 from .. import models
 from .. import users
 from ..decorators import requires_auth
+from . import comment
+from . import file as gistfile
+from . import history
 
 
 class _Gist(models.GitHubCore):

src/github3/gists/history.py

@@ -1,4 +1,5 @@
 """Module containing the GistHistory object."""
+
 from .. import models
 from .. import users
 

src/github3/git.py

@@ -3,6 +3,7 @@
 
 See also: http://developer.github.com/v3/git/
 """
+
 import base64
 from json import dumps
 

src/github3/github.py

@@ -1,4 +1,5 @@
 """This module contains the main interfaces to the API."""
+
 import json
 import re
 import typing as t
@@ -28,7 +29,6 @@
 from .repos import invitation
 from .repos import repo
 
-
 _pubsub_re = re.compile(
     r"https?://[\w\d\-\.\:]+/\w[\w-]+\w/[\w\._-]+/events/\w+"
 )

src/github3/issues/__init__.py

@@ -6,6 +6,7 @@
 
 See also: http://developer.github.com/v3/issues/
 """
+
 from ..utils import timestamp_parameter
 from .issue import Issue
 from .issue import ShortIssue

src/github3/issues/comment.py

@@ -1,4 +1,5 @@
 """Module with class(es) representing issue comments."""
+
 from .. import decorators
 from .. import models
 from .. import users

src/github3/issues/event.py

@@ -1,4 +1,5 @@
 """Issue events logic."""
+
 from .. import users
 from ..models import GitHubCore
 

src/github3/issues/issue.py

@@ -1,15 +1,16 @@
 """Module containing the Issue logic."""
+
 from json import dumps
 
 from uritemplate import URITemplate  # type: ignore
 
+from .. import models
+from .. import users
+from ..decorators import requires_auth
 from . import comment
 from . import event
 from . import label
 from . import milestone
-from .. import models
-from .. import users
-from ..decorators import requires_auth
 
 
 class _Issue(models.GitHubCore):

src/github3/issues/label.py

@@ -1,4 +1,5 @@
 """Module containing the logic for labels."""
+
 from json import dumps
 
 from ..decorators import requires_auth

src/github3/issues/milestone.py

@@ -1,9 +1,9 @@
 from json import dumps
 
-from . import label
 from .. import users
 from ..decorators import requires_auth
 from ..models import GitHubCore
+from . import label
 
 
 class Milestone(GitHubCore):

src/github3/licenses.py

@@ -3,6 +3,7 @@
 
 See also: https://developer.github.com/v3/licenses/
 """
+
 import base64
 
 from . import models

src/github3/models.py

@@ -1,4 +1,5 @@
 """This module provides the basic models used in github3.py."""
+
 import json as jsonlib
 import logging
 import typing as t
@@ -9,7 +10,6 @@
 from . import exceptions
 from . import session
 
-
 if t.TYPE_CHECKING:
     from . import structs
 

src/github3/notifications.py

@@ -3,6 +3,7 @@
 
 See also: http://developer.github.com/v3/activity/notifications/
 """
+
 from json import dumps
 
 from . import models

src/github3/orgs.py

@@ -1,4 +1,5 @@
 """This module contains all of the classes related to organizations."""
+
 import typing as t
 from json import dumps
 

src/github3/projects.py

@@ -1,4 +1,5 @@
 """This module contains all the classes relating to projects."""
+
 from json import dumps
 
 from . import exceptions

src/github3/pulls.py

@@ -1,4 +1,5 @@
 """This module contains all the classes relating to pull requests."""
+
 from json import dumps
 
 from uritemplate import URITemplate  # type: ignore

src/github3/repos/__init__.py

@@ -6,6 +6,7 @@
 
 See also: http://developer.github.com/v3/repos/
 """
+
 from .repo import Repository
 from .repo import ShortRepository
 from .repo import StarredRepository

src/github3/repos/branch.py

@@ -1,14 +1,15 @@
 """Implementation of a branch on a repository."""
+
 import typing as t
 
-from . import commit
 from .. import decorators
 from .. import models
+from . import commit
 
 if t.TYPE_CHECKING:
     from .. import apps as tapps
-    from .. import users as tusers
     from .. import orgs
+    from .. import users as tusers
 
 
 class _Branch(models.GitHubCore):
@@ -603,7 +604,9 @@ class ProtectionRestrictions(models.GitHubCore):
     """
 
     def _update_attributes(self, protection):
-        from .. import apps, orgs, users
+        from .. import apps
+        from .. import orgs
+        from .. import users
 
         self._api = protection["url"]
         self.users_url = protection["users_url"]

src/github3/repos/comment.py

@@ -1,4 +1,5 @@
 """This module contains the RepoComment class."""
+
 from .. import models
 from .. import users
 from ..decorators import requires_auth

src/github3/repos/commit.py

@@ -1,9 +1,10 @@
 """This module contains the RepoCommit classes."""
-from . import status
+
 from .. import checks
 from .. import git
 from .. import models
 from .. import users
+from . import status
 from .comment import RepoComment
 
 

src/github3/repos/comparison.py

@@ -1,6 +1,7 @@
 """This module contains the Comparison object."""
-from . import commit
+
 from .. import models
+from . import commit
 
 
 class Comparison(models.GitHubCore):

src/github3/repos/contents.py

@@ -1,4 +1,5 @@
 """This module contains the Contents object."""
+
 from base64 import b64decode
 from base64 import b64encode
 from json import dumps

src/github3/repos/deployment.py

@@ -1,4 +1,5 @@
 """The module containing deployment logic."""
+
 from .. import users
 from ..models import GitHubCore
 

src/github3/repos/hook.py

@@ -1,4 +1,5 @@
 """This module contains only the Hook object for GitHub's Hook API."""
+
 from json import dumps
 
 from ..decorators import requires_auth

src/github3/repos/invitation.py

@@ -1,4 +1,5 @@
 """Invitation related logic."""
+
 from json import dumps
 
 from .. import models

src/github3/repos/issue_import.py

@@ -1,4 +1,5 @@
 """This module contains the logic for GitHub's import issue API."""
+
 from .. import models
 
 

src/github3/repos/pages.py

@@ -1,4 +1,5 @@
 """GitHub Pages related logic."""
+
 from .. import models
 
 

src/github3/repos/release.py

@@ -1,4 +1,5 @@
 """Release logic for the GitHub API."""
+
 import json
 
 from uritemplate import URITemplate  # type: ignore