Use setuptools_scm, no more hardcoded version / MANIFEST

lukelbd · lukelbd · commit acffc34ec5bb · 2019-11-27T05:55:28.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@
 # PyPi stuff
 build
 dist
+.eggs
 *.egg-info
 
 # Local docs builds
diff --git a/HOWTOCONTRIBUTE.rst b/HOWTOCONTRIBUTE.rst
@@ -165,7 +165,7 @@ and offer suggestions.
 Release procedure
 =================
 
-ProPlot follows semantic versioning, e.g., v1.0.0. A major version causes incompatible
+ProPlot will follow 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.
@@ -176,6 +176,13 @@ API changes, a minor version adds functionality, and a patch covers bug fixes.
 
 #. After all tests pass and the PR has been approved, merge the PR into ``master``.
 
+#. Pull down the new version of master:
+
+   .. code-block:: bash
+
+      git checkout master
+      git pull
+
 #. Tag a release and push to github:
 
    .. code-block:: bash
@@ -187,7 +194,7 @@ API changes, a minor version adds functionality, and a patch covers bug fixes.
 
    .. code-block:: bash
 
-    git clean -xfd # remove any files not checked into git
+    git clean -xfd # remove files not checked into git
     python setup.py sdist bdist_wheel --universal # build package
     twine upload dist/* # register and push to pypi
 
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/proplot/__init__.py b/proplot/__init__.py
@@ -4,10 +4,6 @@
 # Have sepearate files for various categories, so we don't end up with a
 # single enormous 12,000-line file
 #------------------------------------------------------------------------------#
-# Constants
-name = 'ProPlot'
-__version__ = '0.1'
-
 # 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
@@ -55,46 +51,31 @@ def _warning_proplot(message, category, filename, lineno, line=None):
             + '# See https://proplot.readthedocs.io/en/latest/rctools.html\n'
             + lines)
 
-# Initialize customization folders and files
-import os
-_rc_folder = os.path.join(os.path.expanduser('~'), '.proplot')
-if not os.path.isdir(_rc_folder):
-    os.mkdir(_rc_folder)
-for _rc_sub in ('cmaps', 'cycles', 'colors', 'fonts'):
-    _rc_sub = os.path.join(_rc_folder, _rc_sub)
-    if not os.path.isdir(_rc_sub):
-        os.mkdir(_rc_sub)
-_rc_file = os.path.join(os.path.expanduser('~'), '.proplotrc')
-_rc_file_default = os.path.join(os.path.dirname(__file__), '.proplotrc')
-if not os.path.isfile(_rc_file):
-    with open(_rc_file_default) as f:
-        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
-# WARNING: Import order is meaningful! Loads modules that are dependencies
-# of other modules last, and loads styletools early so we can try to update
-# TTFPATH before the fontManager is loaded by other matplotlib modules
+# 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'): # colors and fonts
+    with _benchmark('styletools'):
         from .styletools import *
-    with _benchmark('rctools'): # custom configuration implementation
+    with _benchmark('rctools'):
         from .rctools import *
-    with _benchmark('axistools'): # locators, normalizers, and formatters
+    with _benchmark('axistools'):
         from .axistools import *
-    with _benchmark('wrappers'): # wrappers
+    with _benchmark('wrappers'):
         from .wrappers import *
-    with _benchmark('projs'): # map projections and tools
+    with _benchmark('projs'):
         from .projs import *
-    with _benchmark('axes'): # axes classes
+    with _benchmark('axes'):
         from .axes import *
-    with _benchmark('subplots'): # subplots and figure class
+    with _benchmark('subplots'):
         from .subplots import *
+
+# SCM versioning
+import pkg_resources as _pkg
+name = 'ProPlot'
+try:
+    version = __version__ = _pkg.get_distribution(__name__).version
+except _pkg.DistributionNotFound:
+    version = __version__ = 'unknown'
diff --git a/proplot/styletools.py b/proplot/styletools.py
@@ -2644,12 +2644,14 @@ def _load_cmap_cycle(filename, cmap=False):
 @_timer
 def register_cmaps():
     """
-    Adds colormaps packaged with ProPlot or saved to the ``~/.proplot/cmaps``
+    Add colormaps packaged with ProPlot or saved to the ``~/.proplot/cmaps``
     folder. This is called on import. Maps are registered according to their
     filenames -- for example, ``name.xyz`` will be registered as ``'name'``.
-    Use `show_cmaps` to generate a table of the registered colormaps
 
-    Valid extensions are described in the below table.
+    This is called on import. Use `show_cmaps` to generate a table of the
+    registered colormaps
+
+    Valid extensions are listed in the below table.
 
     =====================  =============================================================================================================================================================================================================
     Extension              Description
@@ -2704,13 +2706,14 @@ def register_cmaps():
 @_timer
 def register_cycles():
     """
-    Adds color cycles packaged with ProPlot or saved to the ``~/.proplot/cycles``
+    Add color cycles packaged with ProPlot or saved to the ``~/.proplot/cycles``
     folder. This is called on import. Cycles are registered according to their
     filenames -- for example, ``name.hex`` will be registered under the name
     ``'name'`` as a `~matplotlib.colors.ListedColormap` map (see `Cycle` for
-    details). Use `show_cycles` to generate a table of the registered cycles.
+    details).
 
-    For valid file formats, see `register_cmaps`.
+    This is called on import. Use `show_cycles` to generate a table of the
+    registered cycles. For valid file formats, see `register_cmaps`.
     """
     # Empty out user-accessible cycle list
     cycles.clear()
@@ -2746,10 +2749,15 @@ def register_cycles():
 @_timer
 def register_colors(nmax=np.inf):
     """
-    Reads full database of crowd-sourced XKCD color names and official
-    Crayola color names, then filters them to be sufficiently "perceptually
-    distinct" in the HCL colorspace. This is called on import. Use `show_colors`
-    to generate a table of the resulting filtered colors.
+    Add color names packaged with ProPlot or saved to the ``~/.proplot/colors``
+    folder. ProPlot loads the crowd-sourced XKCD color
+    name database, Crayola crayon color database, and any user input
+    files, then filters them to be "perceptually distinct" in the HCL
+    colorspace. Files must just have one line per color in the format
+    ``name : hex``. Whitespace is ignored.
+
+    This is called on import. Use `show_colors` to generate a table of the
+    resulting colors.
     """
     # Reset native colors dictionary and add some default groups
     # Add in CSS4 so no surprises for user, but we will not encourage this
@@ -2781,7 +2789,7 @@ def register_colors(nmax=np.inf):
                 dict_ = {name:color for name,color in data}
                 colordict.update({'open': dict_})
                 continue
-            # Other color dictionaries are filtered, and their names are sanitized
+            # Remaining dicts are filtered and their names are sanitized
             i = 0
             dict_ = {}
             ihcls = []
@@ -2803,16 +2811,21 @@ def register_colors(nmax=np.inf):
 
     # Remove colors that are 'too similar' by rounding to the nearest n units
     # WARNING: Unique axis argument requires numpy version >=1.13
-    deleted = 0
-    hcls = hcls/np.array(scale)
-    hcls = np.round(hcls/FILTER_THRESH).astype(np.int64)
-    _, idxs, _ = np.unique(hcls, return_index=True, return_counts=True, axis=0) # get unique rows
-    for idx,(cat,name) in enumerate(pairs):
-        if name not in FILTER_ADD and idx not in idxs:
-            deleted += 1
-        else:
-            colordict[cat][name] = _colordict_unfiltered[cat][name]
-    # Add to colors mapping
+    if hcls.size > 0:
+        hcls = hcls/np.array(scale)
+        hcls = np.round(hcls/FILTER_THRESH).astype(np.int64)
+        deleted = 0
+        _, idxs, _ = np.unique(hcls,
+            return_index=True,
+            return_counts=True,
+            axis=0) # get unique rows
+        for idx,(cat,name) in enumerate(pairs):
+            if name not in FILTER_ADD and idx not in idxs:
+                deleted += 1
+            else:
+                colordict[cat][name] = _colordict_unfiltered[cat][name]
+
+    # Update the color converter
     for _,kw in colordict.items():
         mcolors.colorConverter.colors.update(kw)
 
diff --git a/setup.py b/setup.py
@@ -30,7 +30,6 @@
 setup(
     url = 'https://lukelbd.github.io/proplot',
     name = 'proplot',
-    version = '1.0',
     author = 'Luke Davis',
     author_email = 'lukelbd@gmail.com',
     maintainer = 'Luke Davis',
@@ -42,11 +41,16 @@
         'Source Code': 'https://github.com/lukelbd/proplot'
         },
     packages = ['proplot'],
-    package_data = {'': ['cmaps/*', 'fonts/*', 'colors/*', '.proplotrc']},
-    include_package_data = True, # use MANIFEST.in
     classifiers = classifiers,
+    include_package_data = True, # normally uses MANIFEST.in but setuptools_scm auto-detects tracked files
     install_requires = install_req,
     license = license_text,
     description = 'A comprehensive wrapper for making beautiful, publication-quality graphics.',
     long_description = long_description,
+    use_scm_version={'version_scheme': 'post-release', 'local_scheme': 'dirty-tag'},
+    setup_requires=[
+        'setuptools_scm',
+        'setuptools>=30.3.0',
+        'setuptools_scm_git_archive',
+        ],
     )
