Merge branch 'pep8-cleanup'

Author: lukelbd

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+# See: https://pre-commit.com/hooks.html
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.2.3
+    hooks:
+    - id: double-quote-string-fixer
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-docstring-first
+    - id: check-yaml
+    - id: debug-statements
+    - id: check-merge-conflict
+    - id: no-commit-to-branch
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.2.3
+    hooks:
+    - id: flake8
+      args: ["--max-line-length=88", "--exclude=__init__.py"]

.travis.yml

@@ -31,7 +31,7 @@ install:
   - python setup.py install --user
 
 script:
+  - flake8 proplot --ignore=W503,F401,F403
   - pushd docs
   - make html
   - popd
-

HOWTOCONTRIBUTE.rst

@@ -91,20 +91,35 @@ Preparing pull requests
    If you need some help with git, follow the
    `quick start guide <https://git.wiki.kernel.org/index.php/QuickStart>`__.
 
+#. Install `pre-commit <https://pre-commit.com>`_ and its hook on the ``proplot`` repo
+
+   .. code-block:: bash
+
+      pip install --user pre-commit
+      pre-commit install
+
+   Afterwards ``pre-commit`` will run whenever you commit. https://pre-commit.com/
+   is a framework for managing and maintaining multi-language pre-commit hooks to
+   ensure code-style and code formatting is consistent.
+
+   You can now edit your local working copy as necessary. Please follow
+   PEP-8 naming conventions. When committing, ``pre-commit`` will modify the
+   files as needed, or will generally be clear about what you need to do to
+   pass the commit test.
+
 #. If you intend to make changes / add examples to the ipython notebooks,
    you need to install and configure
    `nbstripout <https://github.com/kynan/nbstripout>`__ with
 
    .. code-block:: bash
 
-      cd proplot
-      pip install nbstripout
+      pip install --user nbstripout
       git config --local include.path ../.gitconfig
 
    This strips notebook cell output when files are staged, which reduces the
    repo storage size and lets us use
    `nbsphinx <https://nbsphinx.readthedocs.io/en/0.4.3/>`__
-   to test each ``git push``, since ``nbsphinx`` must then re-run every cell.
+   to test each ``git push``.
 
    The ``git config`` command associates the filters declared in
    ``proplot/.gitattributes`` with the operations described in ``proplot/.gitconfig``
@@ -118,7 +133,8 @@ Preparing pull requests
       pip install -e .
 
    This way when you ``import proplot``, your
-   local copy is used. Make sure matplotlib is already installed.
+   local copy is used. You can print ``proplot.__file__`` to verify this.
+   Make sure matplotlib is already installed.
 
 #. Break your edits up into reasonably sized commits.
 
@@ -140,11 +156,11 @@ Preparing pull requests
 
    - The entry should be entered as:
 
-      .. code-block::
+     .. code-block::
 
          <description> (:pr:`<PR number>`) `<author name>`_
 
-    where ``<description>`` is the description of the PR related to the change, ``<PR number>`` is the pull request number, and ``<author name>`` is your first and last name.
+     where ``<description>`` is the description of the PR related to the change, ``<PR number>`` is the pull request number, and ``<author name>`` is your first and last name.
 
    - Add yourself to list of authors at the end of ``CHANGELOG.rst`` file if not there yet, in alphabetical order.
 

__init__.py

@@ -1,16 +1,39 @@
 #!/usr/bin/env python3
-#------------------------------------------------------------------------------#
 # Import everything into the top-level module namespace
-# Have sepearate files for various categories, so we don't end up with a
-# single enormous 12,000-line file
-#------------------------------------------------------------------------------#
-# Monkey patch warnings format for warnings issued by ProPlot, make sure to
-# detect if this is just a matplotlib warning traced back to ProPlot code
-# See: https://stackoverflow.com/a/2187390/4970632
-# For internal warning call signature: https://docs.python.org/3/library/warnings.html#warnings.showwarning
-# For default warning source code see: https://github.com/python/cpython/blob/master/Lib/warnings.py
+# Make sure to load styletools early so we can try to update TTFPATH before
+# the fontManager is loaded by other modules (requiring a rebuild)
+import os as _os
 import warnings as _warnings
+import pkg_resources as _pkg
+from .utils import _benchmark
+with _benchmark('total time'):
+    from .utils import *
+    with _benchmark('styletools'):
+        from .styletools import *
+    with _benchmark('rctools'):
+        from .rctools import *
+    with _benchmark('axistools'):
+        from .axistools import *
+    with _benchmark('wrappers'):
+        from .wrappers import *
+    with _benchmark('projs'):
+        from .projs import *
+    with _benchmark('axes'):
+        from .axes import *
+    with _benchmark('subplots'):
+        from .subplots import *
+
+
 def _warning_proplot(message, category, filename, lineno, line=None):
+    """
+    Format for warnings issued by ProPlot. If this is
+    just a matplotlib warning traced back to ProPlot code the *default*
+    warning format is used.
+    See the `internal warning call signature
+    <https://docs.python.org/3/library/warnings.html#warnings.showwarning>`__
+    and the `default warning source code
+    <https://github.com/python/cpython/blob/master/Lib/warnings.py>`__.
+    """
     if line is None:
         try:
             import linecache
@@ -22,13 +45,17 @@ def _warning_proplot(message, category, filename, lineno, line=None):
     else:
         string = f'{filename}:{lineno}: {category.__name__}: {message}'
         if line is not None:
-            string += ('\n' + line) # default behavior
-    return (string + '\n') # must end in newline or not shown in IPython
+            string += ('\n' + line)  # default behavior
+    return (string + '\n')  # must end in newline or not shown in IPython
+
+
+# Apply monkeypatch
+# See: https://stackoverflow.com/a/2187390/4970632
 if _warnings.formatwarning is not _warning_proplot:
     _warnings.formatwarning = _warning_proplot
 
+
 # Initialize customization folders
-import os as _os
 _rc_folder = _os.path.join(_os.path.expanduser('~'), '.proplot')
 if not _os.path.isdir(_rc_folder):
     _os.mkdir(_rc_folder)
@@ -45,35 +72,15 @@ def _warning_proplot(message, category, filename, lineno, line=None):
         lines = ''.join(
             '#   ' + line if line.strip() and line[0] != '#' else line
             for line in f.readlines()
-            )
+        )
     with open(_rc_file, 'x') as f:
-        f.write('# User default settings\n'
-            + '# See https://proplot.readthedocs.io/en/latest/rctools.html\n'
-            + lines)
-
-# Import stuff in reverse dependency order
-# Make sure to load styletools early so we can try to update TTFPATH before
-# the fontManager is loaded by other modules (requiring a rebuild)
-from .utils import _benchmark
-with _benchmark('total time'):
-    from .utils import *
-    with _benchmark('styletools'):
-        from .styletools import *
-    with _benchmark('rctools'):
-        from .rctools import *
-    with _benchmark('axistools'):
-        from .axistools import *
-    with _benchmark('wrappers'):
-        from .wrappers import *
-    with _benchmark('projs'):
-        from .projs import *
-    with _benchmark('axes'):
-        from .axes import *
-    with _benchmark('subplots'):
-        from .subplots import *
+        f.write(
+            '# User default settings\n'
+            '# See https://proplot.readthedocs.io/en/latest/rctools.html\n'
+            + lines
+        )
 
 # SCM versioning
-import pkg_resources as _pkg
 name = 'proplot'
 try:
     version = __version__ = _pkg.get_distribution(__name__).version