Skip to main content

A mappyfile plugin to convert between RGB and Hex colors, and to add human readable names

Project description

Version Build Status

A mappyfile plugin to standardise and convert colors used in a Mapfile. Features include:

  • conversion between RGB and HEX colors

  • harmonise all colors in a Mapfile to either RGB or hex values

  • add human readable color names as comments

  • add color names to RGB color ranges as comments (not currently possible for HEX color ranges)

  • Python2 and 3 compatible

See and rainbow_classes.txt for the Mapfile to generate the above image.


pip install mappyfile-colors

Note installing the mappyfile-colors plugin will automatically install the following dependencies:

  • mappyfile

  • webcolors

Online Demo

  • Go to the online mappyfile demo at

  • Select the “Rainbow colors” map

  • Open “Settings”, the mappyfile-colors Plugin Settings section allows conversion to RGB and HEX, and to include color names as comments in the Mapfile output

  • Click the Format button


To use the colors plugin, import, and then pass in a custom ColorsTransformer. Two additional parameters can also be passed to the mappyfile.loads function:

  • include_color_names - set to True to add color names as comments (default is False)

  • conversion_type - a parameter to convert colors within a Mapfile, either import ConversionType or use an integer value to set the conversion:

    TO_RGB = 1
    TO_HEX = 2

A sample script to convert RGB to HEX colors, and include the color names is shown below.

import mappyfile
from mappyfile.plugins import mappyfile_colors
from mappyfile_colors import ColorsTransformer, ConversionType

s = """
        COLOR 184 134 11
        OUTLINECOLOR 0 0 255
        WIDTH 3

d = mappyfile.loads(s, include_color_names=True, transformerClass=ColorsTransformer, conversion_type=ConversionType.TO_HEX)

This will output the following:

        COLOR "#b8860b" # darkgoldenrod
        OUTLINECOLOR "#0000ff" # blue
        WIDTH 3

See the for further examples.

Color Factory

The plugin also includes a ColorFactory class to return unique colors from color palettes. This can be useful for generating MapServer classes based on unique values. Basic usage is shown below:

color_factory = mappyfile_colors.ColorFactory()
clrs = color_factory.get_colors(palette_name="maximum_contrast")  # returns an iterator


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mappyfile-colors-0.4.0.tar.gz (7.3 kB view hashes)

Uploaded Source

Built Distribution

mappyfile_colors-0.4.0-py2.py3-none-any.whl (6.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page