Metadata-Version: 2.1
Name: colorpedia
Version: 1.2.3
Summary: CLI for Color Lookups
Home-page: https://github.com/joowani/colorpedia
Author: Joohwan Oh
Author-email: joohwan.oh@outlook.com
License: MIT
Description: # Colorpedia
        
        **Colorpedia** is a command-line tool for looking up colors, shades and palettes.
        
        Supported [color models](https://en.wikipedia.org/wiki/Color_model):
        HEX, RGB, HSL, HSV, CMYK.
        
        ![Demo GIF](https://raw.githubusercontent.com/joowani/colorpedia/main/demo.gif)
        ![Build](https://github.com/joowani/colorpedia/workflows/Build/badge.svg?branch=main)
        ![CodeQL](https://github.com/joowani/colorpedia/workflows/CodeQL/badge.svg)
        [![Codecov](https://codecov.io/gh/joowani/colorpedia/branch/main/graph/badge.svg?token=EH6F62KWTB)](https://codecov.io/gh/joowani/colorpedia)
        [![PyPI version](https://badge.fury.io/py/colorpedia.svg)](https://badge.fury.io/py/colorpedia)
        [![GitHub license](https://img.shields.io/github/license/joowani/colorpedia?color=brightgreen)](https://github.com/joowani/colorpedia/blob/main/LICENSE)
        ![Python version](https://img.shields.io/badge/python-3.6%2B-blue)
        
        ## Requirements
        
        * Modern terminal with true color and utf-8 support
          (e.g. Windows Terminal, PowerShell, iTerm2, Terminator)
        * Python 3.6+
        
        ## Installation
        
        Install via [pip](https://pip.pypa.io):
        
        ```shell
        pip install colorpedia
        ```
        
        For [conda](https://docs.conda.io) users:
        
        ```shell
        conda install colorpedia -c conda-forge
        ```
        
        You can then use the `color` command:
        
        ```shell
        color --help
        ```
        
        If you have a name collision on Windows, use `colorpedia` instead:
        
        ```shell
        colorpedia --help
        ```
        
        ## Usage
        
        Look up colors using various color models:
        
        ```shell
        color name green            # CSS3 color name
        color hex FFFFFF            # hex code without the hash (#) prefix
        color rgb 255 255 255       # RGB (Red Green Blue)
        color hsl 360 100 100       # HSL (Hue Saturation Lightness)
        color hsv 360 100 100       # HSV (Hue Saturation Brightness)
        color cmyk 100 100 100 100  # CMYK (Cyan Magenta Yellow Black)
        ```
        
        Use `--shades` to display shades of a color:
        
        ```shell
        color name green --shades    # Display 15 colors by default
        color hex FFFFFF --shades=5  # Display 5 shades
        ```
        
        Look up color palettes:
        
        ```shell
        color palette molokai
        color palette facebook
        color palette zenburn
        ```
        
        Control the output with global flags:
        
        ```shell
        color name yellow --all      # Display all details
        color name yellow --json     # Display in JSON format
        color name yellow --units    # Display unit symbols
        color name yellow --nojson   # Do not display in JSON
        color name yellow --nounits  # Do not display unit symbols
        ```
        
        Combine with other command-line tools like [jq](https://github.com/stedolan/jq):
        
        ```shell
        color palette molokai | cut -d'|' -f 2,3,4
        color name blue --range --json | jq .[0].name
        ```
        
        Use `--help` to display more information on each subcommand:
        
        ```shell
        color name --help
        color rgb --help
        color palette --help
        ```
        
        ## Tab Completion
        
        For Bash, add the following line in `~/.bashrc` or `~/.bash_profile`:
        
        ```shell
        source <(color -- --completion)
        ```
        
        For Zsh, add the following lines in `~/.zshrc`:
        
        ```shell
        autoload -U +X compinit && compinit
        autoload -U +X bashcompinit && bashcompinit
        
        source <(color -- --completion | sed "s/:/: /g")
        ```
        
        Replace `color` with `colorpedia` if you are using the latter.
        
        ## Configuration
        
        Initialize the configuration file to customize CLI behavior:
        
        ```shell
        color config init
        ```
        
        The command above creates `~/.config/colorpedia/config.json` with default settings:
        
        ```javascript
        {
          // Always display in JSON format. Use with --nojson global flag.
          "always_output_json": false,
          
          // Suffix for approximate color names (e.g. "green~").
          "approx_name_suffix": "~",
          
          // Default number of shades displayed when --shades is used without a count.
          "default_shades_count": 15,
          
          // Display degrees angle (°) symbol. Use with --nounits global flag.
          "display_degree_symbol": false,
          
          // Display percentage (%) symbol. Use with --nounits global flag.
          "display_percent_symbol": false,
          
          // Height of the color box displayed in single-color (get) view.
          "get_view_color_height": 10,
          
          // Width of the color box displayed in single-color (get) view.
          "get_view_color_width": 20,
          
          // Keys displayed in single-color (get) view.
          "get_view_keys": ["name", "hex", "rgb", "color", "hsl", "hsv", "cmyk"],
          
          // Keys displayed in JSON view.
          "json_keys": ["name", "is_name_exact", "hex", "rgb", "hsl", "hsv", "cmyk"],
          
          // Width of the color box displayed in multi-color (list) view.
          "list_view_color_width": 20,
          
          // Keys displayed in multi-color (list) view.
          "list_view_keys": ["name", "hex", "rgb", "color", "hsl", "hsv", "cmyk"],
          
          // Always uppercase hex codes if set to true, lowercase if set to false.
          "uppercase_hex_codes": true
        }
        ```
        
        Display or edit the configuration file:
        
        ```shell
        color config show  # Display configuration
        color config edit  # Edit configuration via a text editor
        ```
        
        ## Technical Notes
        
        - Names of "unknown" colors are approximated using minimum RGB delta:
          ```
          delta = (R1 - R2) ^ 2 + (G1 - G2) ^ 2 + (B1 - B2) ^ 2
          ```
          If there is are ties, all names are included in the output.
        - Percentage values use 0 - 100 scale by default, 0 - 1 scale in JSON.
        - Degree angles use 0 - 360 scale by default, 0 - 1 scale in JSON.
        - Percent and degree unit symbols are omitted in JSON.
        - If HSV/HSL/CMYK values do not map exactly to an RGB triplet, they are rounded to the
          nearest one.
        
Keywords: cli,color,terminal
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
