Code qaulity, Colormap.from_list improvements, cyclic + transparent maps, more docs

Author: lukelbd

.codacy.yml

@@ -1,8 +1,8 @@
 ---
 exclude_paths:
   - 'docs/**'
+  - 'proplot/tests/**'
   - 'proplot/fonts/**'
   - 'proplot/colors/**'
   - 'proplot/cycles/**'
   - 'proplot/cmaps/**'
-  - 'proplot/cmaps_rejects/**'

docs/.gitconfig .gitconfigdocs/.gitconfig renamed to .gitconfig

@@ -8,29 +8,26 @@ build
 dist
 *.egg-info
 
-# Builds made during testing
+# Local docs builds
 docs/api
 docs/_build
 
-# Deleted
-trash
-notebooks*
-garbage
+# Notebook stuff
+**/tests/*.ipynb
+.ipynb_checkpoints
 
 # Python extras
 *.log
 *.pyc
 .*.pyc
 __pycache__
 
-# Notebooks
-# NOTE: For now ignore, contributors just need RST files to build docs and
-# have personal control over quickstart.
-**/tests/*.ipynb
-.ipynb_checkpoints
-
 # OS files
 .DS_Store
 .DS_Store?
 ._*
 .Trashes
+
+# Old files
+trash
+garbage

.gitignore

@@ -3,11 +3,11 @@ Contribution guide
 ==================
 
 Contributions are highly welcomed and appreciated.  Every little help counts,
-so do not hesitate! You can make a high impact on ``proplot`` just by using it and
+so do not hesitate! You can make a high impact on ProPlot just by using it and
 reporting `issues <https://github.com/lukelbd/proplot/issues>`__.
 
 The following sections cover some general guidelines
-regarding development in ``proplot`` for maintainers and contributors.
+regarding development in ProPlot for maintainers and contributors.
 Nothing here is set in stone and can't be changed.
 Feel free to suggest improvements or changes in the workflow.
 
@@ -16,7 +16,7 @@ Feature requests and feedback
 
 We are eager to hear about your requests for new features and any suggestions about the
 API, infrastructure, and so on. Feel free to submit these as
-`issues <https://github.com/lukelbd/proplot/issues/new>`__ with the label "feature request."
+`issues <https://github.com/lukelbd/proplot/issues/new>`__ with the label "feature."
 
 Please make sure to explain in detail how the feature should work and keep the scope as
 narrow as possible. This will make it easier to implement in small PRs.
@@ -25,14 +25,14 @@ narrow as possible. This will make it easier to implement in small PRs.
 Report bugs
 ===========
 
-Report bugs for ``proplot`` in the `issue tracker <https://github.com/lukelbd/proplot/issues>`__
+Report bugs for ProPlot in the `issue tracker <https://github.com/lukelbd/proplot/issues>`__
 with the label "bug".
 
 If you are reporting a bug, please include:
 
 * Your operating system name and version.
 * Any details about your local setup that might be helpful in troubleshooting,
-  specifically the Python interpreter version, installed libraries, and ``proplot``
+  specifically the Python interpreter version, installed libraries, and ProPlot
   version.
 * Detailed steps to reproduce the bug.
 
@@ -50,7 +50,7 @@ Talk to developers to find out how you can fix specific bugs.
 Write documentation
 ===================
 
-`proplot` could always use better documentation. For small changes, you can edit documentation files directly in the GitHub web interface,
+ProPlot could always use better documentation. For small changes, you can edit documentation files directly in the GitHub web interface,
 without using a local copy.
 
 * The documentation is written in reStructuredText with `numpydoc <https://numpydoc.readthedocs.io/en/latest/>`__ style headers.
@@ -75,7 +75,7 @@ Preparing pull requests
 
 #. Fork the
    `proplot GitHub repository <https://github.com/lukelbd/proplot>`__.  It's
-   fine to use ``proplot`` as your fork repository name because it will live
+   fine to use ProPlot as your fork repository name because it will live
    under your user.
 
 #. Clone your fork locally using `git <https://git-scm.com/>`__, connect your repository
@@ -105,10 +105,13 @@ Preparing pull requests
    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.
-   The ``git config`` command configures the filters referenced in
-   ``proplot/.gitattributes`` with the options declared in ``proplot/.gitconfig``.
 
-#. Make an editable install of proplot by running:
+   The ``git config`` command associates the filters declared in
+   ``proplot/.gitattributes`` with the operations described in ``proplot/.gitconfig``
+   by adding them to the *recognized* local configuration file
+   ``proplot/.git/config``.
+
+#. Make an editable install of ProPlot by running:
 
    .. code-block:: bash
 
@@ -127,19 +130,16 @@ Preparing pull requests
    The commit messages should be short, sweet, and use the imperative mood,
    e.g. "Fix bug" instead of "Fixed bug".
 
-#. Run all the tests. Now running tests is as simple as issuing this command:
-
-   .. code-block:: bash
-
-      coverage run --source proplot -m py.test
-
-   This command will run tests via the ``pytest`` tool against Python 3.7.
-
+   ..
+      #. Run all the tests. Now running tests is as simple as issuing this command:
+         .. code-block:: bash
+            coverage run --source proplot -m py.test
+         This command will run tests via the ``pytest`` tool against Python 3.7.
 
 #. Create a new changelog entry in ``CHANGELOG.rst``:
 
    - The entry should be entered as:
-     
+
       .. code-block::
 
          <description> (:pr:`<PR number>`) `<author name>`_
@@ -159,13 +159,13 @@ Preparing pull requests
       base: master
 
 Note that you can create the Pull Request while you're working on this. The PR will update
-as you add more commits. ``proplot`` developers and contributors can then review your code
+as you add more commits. ProPlot developers and contributors can then review your code
 and offer suggestions.
 
 Release procedure
 =================
 
-``proplot`` follows semantic versioning, e.g., v1.0.0. A major version causes incompatible
+ProPlot follows semantic versioning, e.g., v1.0.0. A major version causes incompatible
 API changes, a minor version adds functionality, and a patch covers bug fixes.
 
 #. Create a new branch ``release-vX.x.x`` with the version for the release.

HOWTOCONTRIBUTE.rst

@@ -1,7 +1,7 @@
 .. image:: docs/_static/logo_long.png
    :width: 1000px
 
-|build-status| |coverage| |quality| |docs| |license| |pr-welcome| |donations|
+|build-status| |coverage| |quality| |docs| |license| |gitter| |pr-welcome| |donations|
 
 A comprehensive, easy-to-use `matplotlib <https://matplotlib.org/>`__ wrapper for making beautiful, publication-quality graphics.
 
@@ -15,8 +15,6 @@ Donations
 =========
 At well over 10,000 lines of code, this package took a huge amount of time to write and an equally huge amount of time to share online -- especially with my day job as a graduate student. If ProPlot has been useful for you, consider clicking the `"donate" badge <https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VMJSNABTFF4AA&source=url>`__ and sending me a small donation.
 
-.. Links and badges
-
 .. |build-status| image:: https://img.shields.io/travis/lukelbd/proplot.svg?style=flat
     :alt: build status
     :target: https://travis-ci.org/lukelbd/proplot
@@ -37,6 +35,10 @@ At well over 10,000 lines of code, this package took a huge amount of time to wr
     :alt: docs
     :target: https://proplot.readthedocs.io/en/latest/?badge=latest
 
+.. |gitter| image:: https://badges.gitter.im/gitterHQ/gitter.svg
+   :alt: gitter
+   :target: https://gitter.im/pro-plot/community
+
 .. |pr-welcome| image:: https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?
    :alt: PR welcome
    :target: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project

README.rst

@@ -67,6 +67,10 @@
     'pr': ('https://github.com/lukelbd/proplot/pull/%s', 'GH#'),
 }
 
+# Give *lots* of time for cell execution! The projection tables
+# in particular are massive.
+nbsphinx_timeout = 120
+
 # Do not run doctest tests, these are just to show syntax and expected
 # output may be graphical
 doctest_test_doctest_blocks = ''

docs/.gitattributes

@@ -124,7 +124,7 @@
     "ax.format(title='Cycle from color')\n",
     "# Example 2\n",
     "ax = axs[1]\n",
-    "cycle = plot.Cycle('blues', 'reds', 'oranges', 15, left=[0.1]*3)\n",
+    "cycle = plot.Cycle('blues', 'reds', 'oranges', 15, left=0.1)\n",
     "lines = ax.plot(data[:,:15], cycle=cycle, lw=5)\n",
     "f.colorbar(lines, loc='b', col=2, values=np.arange(0,len(lines)), locator=2)\n",
     "f.legend(lines, loc='b', col=2, labels=np.arange(0,len(lines)), ncols=4)\n",

docs/conf.py

@@ -23,7 +23,7 @@ Why didn't you add to matplotlib directly?
 
 Since ProPlot is built right into the matplotlib API, you might be wondering why we didn't contribute to the matplotlib project directly. The main answer is *speed* and *autonomy*, but there are a few practical limitations:
 
-* Certain features directly conflict with matplotlib. For example, ProPlot's "smart tight layout" conflicts with matplotlib's `tight layout <https://matplotlib.org/tutorials/intermediate/tight_layout_guide.html>`__ by permitting *fluid figure dimensions*. Also, the new `~proplot.subplots.FlexibleGridSpec` class permits *variable spacing* between rows and columns, and specifies spacing in *physical units* instead of figure-relative and axes-relative units.
+* Certain features directly conflict with matplotlib. For example, ProPlot's tight layout algorithm conflicts with matplotlib's `tight layout <https://matplotlib.org/tutorials/intermediate/tight_layout_guide.html>`__ by permitting *fluid figure dimensions*, and the `~proplot.subplots.FlexibleGridSpec` class permits *variable spacing* between rows and columns and uses *physical units* rather than figure-relative and axes-relative units.
 * Other features may be too redundant. For example, `~proplot.axes.Axes.format` is convenient, but the same tasks can be accomplished with existing axes and axis "setter" methods. Also, some of the functionality of `~proplot.subplots.subplots` can be replicated with `axes_grid1 <https://matplotlib.org/mpl_toolkits/axes_grid1/index.html>`__. Following `TOOWTDI <https://wiki.python.org/moin/TOOWTDI>`__ philosophy, these features should probably not be integrated.
 
 Nevertheless, if any core matplotlib think that some of ProPlot's features should be added to matplotlib, please contact core developer `Luke Davis <https://github.com/lukelbd>`__ and let him know!

docs/cycles.ipynb

@@ -6,6 +6,7 @@
 # since otherwise setup.py will not think it is necessary to rebuild
 lxml>=4.0.0
 pyyaml>=5.0.0
+sphinx>=2.2.0
 numpy>=1.14
 ipython>=7.0.0
 ipykernel>=5.0.0