Metadata-Version: 2.1
Name: colormap
Version: 1.2.0
Summary: Commn utilities to ease development of Python packages
License: BSD-3-Clause
Keywords: config,decorators,development
Author: Thomas Cokelaer
Author-email: thomas.cokelaer@pasteur.fr
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: importlib_resources (>6) ; python_version >= "3.9" and python_full_version <= "3.10.0"
Requires-Dist: matplotlib (>=3,<4) ; python_version < "3.12"
Requires-Dist: matplotlib (>=3.9.2,<4.0.0) ; python_version >= "3.12" and python_version < "4.0"
Requires-Dist: numpy (<2) ; python_version < "3.9"
Requires-Dist: numpy (>=2,<3) ; python_version >= "3.9" and python_version < "4.0"
Description-Content-Type: text/x-rst

#############################
COLORMAP documentation
#############################


Please see : http://colormap.readthedocs.io/ for an up-to-date documentation.

.. image:: https://badge.fury.io/py/colormap.svg
    :target: https://pypi.python.org/pypi/colormap

.. image:: https://github.com/cokelaer/colormap/actions/workflows/ci.yml/badge.svg?branch=main
    :target: https://github.com/cokelaer/colormap/actions/workflows/ci.yml

.. image:: https://coveralls.io/repos/cokelaer/colormap/badge.png?branch=main
    :target: https://coveralls.io/r/cokelaer/colormap?branch=main


:version: Python 3.8, 3.9, 3.10, 3.11, 3.12
:contributions: Please join https://github.com/cokelaer/colormap
:issues: Please use https://github.com/cokelaer/colormap/issues
:notebook: Please see https://github.com/cokelaer/colormap/tree/main/notebooks


What is it ?
################

**colormap** package provides simple utilities to convert colors between
RGB, HEX, HLS, HUV and a class to easily build colormaps for matplotlib. All
matplotlib colormaps and some R colormaps are available altogether. The
plot_colormap method (see below) is handy to quickly pick up a colormaps and
the test_colormap is useful to see test a new colormap.


Installation
###################

::

    pip install colormap

Example
##########

* Create your own colormap from red to green colors with intermediate color as
  whitish (diverging map from red to green)::

      c = Colormap()
      mycmap = c.cmap( {'red':[1,1,0], 'green':[0,1,.39], 'blue':[0,1,0]})
      cmap = c.test_colormap(mycmap)

* Even simpler if the colormap is linear::

      c = Colormap()
      mycmap = c.cmap_linear('red', 'white', 'green(w3c)')
      cmap = c.test_colormap(mycmap)

.. image:: https://colormap.readthedocs.io/en/latest/_images/quickstart-6.png
    :width: 50%
    :align: center

* check out the available colormaps::

      c = Colormap()
      c.plot_colormap('diverging')

.. image:: https://colormap.readthedocs.io/en/latest/_images/quickstart-4.png
    :width: 50%
    :align: center

See online documentation for details: http://colormap.readthedocs.io/

changelog
#########

========= ================================================================================
Version   Description
========= ================================================================================
1.1.0     * switch to pyproject. remove easydev dependency. compat for python 3.11 and
            3.12
1.0.6     * Fix a matplotlib deprecation
          * Fix RTD documentation
1.0.5     * remove Python3.6 and added Python3.10 to CI action
          * Fix issue in setup reported in https://github.com/cokelaer/colormap/pull/14
          * add requirements in MANIFEST
          * applied black on all files
========= ================================================================================

