Example repo.

Author: anntzer

.gitignore

@@ -0,0 +1,16 @@
+*.egg-info
+.*.swp
+*.o
+*.pyc
+*.pyd
+*.so
+.cache/
+.eggs/
+.ipynb_checkpoints/
+.pytest_cache/
+build/
+dist/
+htmlcov/
+oprofile_data/
+.coverage
+.gdb_history

LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) YEAR, AUTHOR
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.rst

@@ -0,0 +1,33 @@
+Template package for distributing Matplotlib colormaps
+======================================================
+
+This is a template package for distributing Matplotlib colormaps as Python
+packages.
+
+To use it, clone this repository, edit the (intentionally commented-out)
+metadata in ``setup.py``, and edit the colormap data in ``lib/nifty.py`` and
+rename it to your own colormap name.
+
+You can then install the package using ``pip install ...`` (or alternatively
+just move ``lib/nifty.py`` into your own Python project), then use the colormap
+with e.g.
+
+.. code-block:: python
+
+   from matplotlib import pyplot as plt
+   import nifty
+
+   fig, ax = plt.subplots()
+   ax.imshow([[0, 1], [2, 3]], cmap=nifty.cmap)
+
+   # or register the colormap to use the name as string
+
+   nifty.register_cmap()
+   fig, ax = plt.subplots()
+   ax.imshow([[0, 1], [2, 3]], cmap="nifty")
+
+and just visualize the colormap with
+
+.. code-block:: sh
+
+   $ python -m nifty

lib/nifty.py

@@ -0,0 +1,32 @@
+from matplotlib import colors as mcolors, cm
+
+
+# The name of the colormap.
+_colormap_name = "nifty"
+# The colormap data, as a list of RGB tuples.
+_colormap_data = [
+    (0.0, 0.0, 0.0),
+    (0.0, 0.0, 0.5),
+    (0.0, 0.5, 0.5),
+    (0.5, 0.5, 0.5),
+    (0.5, 0.5, 1.0),
+    (1.0, 1.0, 1.0),
+]
+
+
+cmap = mcolors.ListedColormap(_colormap_data, _colormap_name)
+
+
+def register_cmap():
+    cm.register_cmap(cmap=cmap)
+
+
+if __name__ == "__main__":
+
+    from matplotlib import pyplot as plt
+
+    fig = plt.figure()
+    sm = cm.ScalarMappable(cmap=cmap)
+    sm.set_array([])
+    fig.colorbar(sm)
+    plt.show()

setup.py

@@ -0,0 +1,15 @@
+from setuptools import find_packages, setup
+
+
+setup(
+    name=#"nifty-cmap",
+    version=#"0.1",
+    description=#"A nifty description.",
+    author=#"Me",
+    author_email=#"my@email.address",
+    url=#"https://my.url",
+    license=#"MIT",
+    py_modules=#["nifty"],
+    package_dir={"": "lib"},
+    install_requires=["matplotlib"],
+)