Add isort to sort imports alphabetically (#745)

Author: seisman

.github/workflows/ci_tests.yaml

@@ -32,7 +32,7 @@ jobs:
 
       - name: Install packages
         run: |
-          pip install black blackdoc flake8 pylint
+          pip install black blackdoc flake8 pylint isort
           sudo apt-get install dos2unix
 
       - name: Formatting check (black and flake8)

.github/workflows/format-command.yml

@@ -26,7 +26,7 @@ jobs:
       # Install formatting tools
       - name: Install formatting tools
         run: |
-          pip install black blackdoc flake8
+          pip install black blackdoc flake8 isort
           sudo apt-get install dos2unix
 
       # Run "make format" and commit the change to the PR branch

CONTRIBUTING.md

@@ -245,7 +245,12 @@ directory).
 
 ### Code style
 
-We use [Black](https://github.com/ambv/black) and [blackdoc](https://github.com/keewis/blackdoc)
+We use some tools:
+
+- [Black](https://github.com/ambv/black)
+- [blackdoc](https://github.com/keewis/blackdoc)
+- [isort](https://pycqa.github.io/isort/)
+
 to format the code so we don't have to think about it.
 Black loosely follows the [PEP8](http://pep8.org) guide but with a few differences.
 Regardless, you won't have to worry about formatting the code yourself.
@@ -268,7 +273,7 @@ common errors.
 The [`Makefile`](Makefile) contains rules for running both checks:
 
 ```bash
-make check   # Runs flake8, black and blackdoc (in check mode)
+make check   # Runs flake8, black, blackdoc and isort (in check mode)
 make lint    # Runs pylint, which is a bit slower
 ```
 

Makefile

@@ -15,7 +15,7 @@ help:
 	@echo "  install   install in editable mode"
 	@echo "  test      run the test suite (including doctests) and report coverage"
 	@echo "  format    run black and blackdoc to automatically format the code"
-	@echo "  check     run code style and quality checks (black, blackdoc and flake8)"
+	@echo "  check     run code style and quality checks (black, blackdoc, isort and flake8)"
 	@echo "  lint      run pylint for a deeper (and slower) quality check"
 	@echo "  clean     clean up build and generated files"
 	@echo "  distclean clean up build and generated files, including project metadata files"
@@ -36,10 +36,12 @@ test:
 	rm -r $(TESTDIR)
 
 format:
+	isort .
 	black $(BLACK_FILES)
 	blackdoc $(BLACKDOC_OPTIONS) $(BLACK_FILES)
 
 check:
+	isort . --check
 	black --check $(BLACK_FILES)
 	blackdoc --check $(BLACKDOC_OPTIONS) $(BLACK_FILES)
 	flake8 $(FLAKE8_FILES)

doc/conf.py

@@ -5,13 +5,16 @@
 # pylint: disable=invalid-name
 
 import datetime
+
+# isort: off
 from sphinx_gallery.sorting import (  # pylint: disable=no-name-in-module
-    FileNameSortKey,
     ExplicitOrder,
+    FileNameSortKey,
 )
-from pygmt import __version__, __commit__
+from pygmt import __commit__, __version__
 from pygmt.sphinx_gallery import PyGMTScraper
 
+# isort: on
 
 extensions = [
     "sphinx.ext.autodoc",

environment.yml

@@ -20,6 +20,7 @@ dependencies:
     - coverage[toml]
     - black
     - blackdoc
+    - isort>=5
     - pylint
     - flake8
     - sphinx

examples/gallery/grid/grdview_surface.py

@@ -12,8 +12,8 @@
 45° with ``shading="+a45"``.
 """
 
-import pygmt
 import numpy as np
+import pygmt
 import xarray as xr
 
 

examples/tutorials/plot.py

@@ -11,7 +11,6 @@
 
 import pygmt
 
-
 ########################################################################################
 # For example, let's load the sample dataset of tsunami generating earthquakes around
 # Japan (:func:`pygmt.datasets.load_japan_quakes`). The data is loaded as a

examples/tutorials/text.py

@@ -7,6 +7,7 @@
 """
 
 import os
+
 import pygmt
 
 ###############################################################################

pygmt/__init__.py

@@ -12,16 +12,17 @@
 from pkg_resources import get_distribution
 
 # Import modules to make the high-level GMT Python API
-from pygmt.session_management import begin as _begin, end as _end
+from pygmt import datasets
 from pygmt.figure import Figure
 from pygmt.filtering import blockmedian
 from pygmt.gridding import surface
-from pygmt.sampling import grdtrack
-from pygmt.mathops import makecpt
-from pygmt.modules import GMTDataArrayAccessor, config, info, grdinfo, which
 from pygmt.gridops import grdcut, grdfilter
-from pygmt.x2sys import x2sys_init, x2sys_cross
-from pygmt import datasets
+from pygmt.mathops import makecpt
+from pygmt.modules import GMTDataArrayAccessor, config, grdinfo, info, which
+from pygmt.sampling import grdtrack
+from pygmt.session_management import begin as _begin
+from pygmt.session_management import end as _end
+from pygmt.x2sys import x2sys_cross, x2sys_init
 
 # Get semantic version through setuptools-scm
 __version__ = f'v{get_distribution("pygmt").version}'  # e.g. v0.1.2.dev3+g0ab3cd78
@@ -60,10 +61,10 @@ def show_versions():
     - GMT library information
     """
 
-    import sys
-    import platform
     import importlib
+    import platform
     import subprocess
+    import sys
 
     def _get_module_version(modname):
         """Get version information of a Python module."""