Move linting to dedicated file, add 'isort' and 'doc8'

Author: lukelbd

.pre-commit-config.yaml

@@ -1,13 +1,36 @@
 # See: https://pre-commit.com/hooks.html
+# Must put flake8 in separate group so 'black' is executed first
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.2.3
+    rev: v3.1.0
     hooks:
     - id: no-commit-to-branch
     - id: double-quote-string-fixer
     - id: check-docstring-first
     - id: check-merge-conflict
     - id: end-of-file-fixer
     - id: trailing-whitespace
+
+  # - repo: https://github.com/ambv/black
+  #   rev: 19.10
+  #   hooks:
+  #   - id: black
+  #     args: ['--line-length', '88', '--skip-string-normalization']
+
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v4.3.21
+    hooks:
+    - id: isort
+      args: ['--line-width', '88']
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 3.8.3
+    hooks:
     - id: flake8
       args: ['--max-line-length=88', '--ignore=W503,E402,E741']
+
+  - repo: https://github.com/PyCQA/doc8
+    rev: 0.8.1
+    hooks:
+    - id: doc8
+      args: ['--max-line-length', '88', '--allow-long-titles']

.travis.yml

@@ -1,8 +1,6 @@
 # Travis Continuos Integration
 # Currently only tests notebook files
 # Based on http://conda.pydata.org/docs/travis.html
-# Not sure why pip install . is necessary since conf.py adds it
-# to the the path. Maybe nbsphinx executes in separate environment.
 sudo: false # use container based build
 language: python
 notifications:
@@ -30,15 +28,16 @@ before_install:
   - conda info -a
 
 install:
-  - conda env create -n proplot-dev --file docs/environment.yml
+  - conda env create -n proplot-dev --file ci/environment.yml
   - source activate proplot-dev
-  - pip install flake8
   - conda list
   - which conda
   - which python
+  - pip install .
+  - python setup.py install --user
 
 script:
-  - flake8 proplot docs --max-line-length=88 --ignore=W503,E402,E741
+  - ci/run-linter.sh
   - pushd docs
   - make html
   - popd

ci/environment.yml

@@ -0,0 +1,33 @@
+# Hard requirements for running tests
+# NOTE: Basemap is broken as of matplotlib >=3.3 so for documentation
+# use 3.2.1. Probably lots of basemap holdouts for next ~5 years.
+# NOTE: PyQt5 is needed by pyplot, RTD server *happens* to already have it
+# but creating local environment will fail.
+name: proplot-dev
+channels:
+  - conda-forge
+dependencies:
+  - python>=3.6
+  - numpy
+  - xarray
+  - pandas
+  - matplotlib==3.2.1
+  - cartopy
+  - basemap
+  - pandoc
+  - ipykernel
+  - pip
+  - pip:
+    - ..
+    - flake8
+    - isort
+    - doc8
+    - pytest
+    - pytest-sugar
+    - sphinx>=3.0
+    - sphinx-copybutton
+    - sphinx_rtd_theme
+    - jupytext
+    - nbsphinx
+    - git+https://github.com/lukelbd/[email protected]
+    - pyqt5

ci/run-linter.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+set -e
+set -eo pipefail
+
+echo 'Code Styling with (flake8, isort)'
+
+source activate proplot-dev
+
+echo '[flake8]'
+flake8 proplot docs --max-line-length=88 --ignore=W503,E402,E741
+
+# TODO: Add this
+# echo '[black]'
+# black --check -S proplot
+
+echo '[isort]'
+isort --recursive --check-only --line-width=88 proplot
+
+echo '[doc8]'
+doc8 *.rst docs --max-line-length=88

docs/environment.yml

@@ -1,5 +1,4 @@
 # Hard requirements for notebook examples and documentation build
-# Proplot itself just needs matplotlib
 # NOTE: Basemap is broken as of matplotlib >=3.3 so for documentation
 # use 3.2.1. Probably lots of basemap holdouts for next ~5 years.
 # NOTE: PyQt5 is needed by pyplot, RTD server *happens* to already have it