Metadata-Version: 2.1
Name: chrys
Version: 3.1.2
Summary: A collection of color palettes for mapping and visualisation
Home-page: https://github.com/netbek/chrys
Author: Hein Bekker
Author-email: hein@netbek.co.za
License: BSD-3-Clause
Description: # chrys
        
        [![CircleCI](https://circleci.com/gh/netbek/chrys.svg?style=svg)](https://circleci.com/gh/netbek/chrys)
        
        A collection of color palettes for mapping and visualisation.
        
        ## Demo
        
        [netbek.github.io/chrys](https://netbek.github.io/chrys)
        
        ## Node.js
        
        ### Installation
        
        ```shell
        npm install chrys
        ```
        
        ### Usage
        
        Generate a new palette as a subset of a given palette:
        
        ```javascript
        >>> const {VEGA_PALETTES, toDiscretePalette} = require('chrys');
        >>> toDiscretePalette(VEGA_PALETTES['viridis'], 6);
        ['#46327f', '#375c8d', '#27808e', '#1fa187', '#4ac26d', '#9fda3a']
        ```
        
        Generate a new palette as a subset of a palette from a given provider:
        
        ```javascript
        >>> const {VEGA_VIRIDIS, discretePalette} = require('chrys');
        >>> discretePalette(VEGA_VIRIDIS, 6);
        ['#46327f', '#375c8d', '#27808e', '#1fa187', '#4ac26d', '#9fda3a']
        ```
        
        Get the vendor library and palette names from a given name:
        
        ```javascript
        >>> const {VEGA_VIRIDIS, parsePaletteName} = require('chrys');
        >>> parsePaletteName(VEGA_VIRIDIS);
        {vendor: 'vega', palette: 'viridis'}
        ```
        
        ## Sass
        
        ### Installation
        
        ```shell
        npm install chrys
        ```
        
        ### Usage
        
        ```scss
        @import 'node_modules/chrys/src/variables';
        
        // Get the first color of the `bokeh-colorblind` palette, size 3
        $palette-name: 'bokeh-colorblind';
        $palette-size: 3;
        $palette:      map-get(map-get($chrys-palettes, $palette-name), $palette-size);
        $color:        nth($palette, 1);
        
        div {
          background: $color;
        }
        ```
        
        ## Python
        
        ### Installation
        
        ```shell
        pip install chrys
        ```
        
        ### Usage
        
        Generate a new palette as a subset of a given palette:
        
        ```python
        >>> from chrys.palettes import VEGA_PALETTES, to_continuous_palette, to_discrete_palette
        >>> to_discrete_palette(VEGA_PALETTES['viridis'], 6)
        ['#46327f', '#375c8d', '#27808e', '#1fa187', '#4ac26d', '#9fda3a']
        >>> to_continuous_palette(VEGA_PALETTES['viridis'][256], 6)
        ['#440356', '#414587', '#2a788e', '#22a884', '#79d152', '#fbe724']
        ```
        
        Generate a new palette as a subset of a palette from a given provider:
        
        ```python
        >>> from chrys.palettes import VEGA_VIRIDIS, continuous_palette, discrete_palette
        >>> discrete_palette(VEGA_VIRIDIS, 6)
        ['#46327f', '#375c8d', '#27808e', '#1fa187', '#4ac26d', '#9fda3a']
        >>> continuous_palette(VEGA_VIRIDIS, 6)
        ['#440356', '#414587', '#2a788e', '#22a884', '#79d152', '#fbe724']
        ```
        
        Get the vendor library and palette names from a given name:
        
        ```python
        >>> from chrys.palettes import VEGA_VIRIDIS, parse_palette_name
        >>> parse_palette_name(VEGA_VIRIDIS)
        PaletteName(vendor='vega', palette='viridis')
        ```
        
        ## Development
        
        Install Node and Python dependencies:
        
        ```shell
        ./scripts/install.sh
        ```
        
        Build palette data:
        
        ```shell
        npm run build-data
        ```
        
        Build JavaScript and Python distribution packages, Sass, CSS, Illustrator scripts:
        
        ```shell
        npm run build-dist
        ```
        
        Deploy documentation to GitHub Pages:
        
        ```shell
        npm run deploy
        ```
        
        Publish JavaScript and Python distribution packages:
        
        ```shell
        npm publish
        ```
        
        ## Credit
        
        Palettes from:
        
        * [Bokeh](https://github.com/bokeh/bokeh) (BSD 3-Clause)
        * [Vega](https://github.com/vega/vega) (BSD 3-Clause)
        
        ## License
        
        Copyright (c) 2017 Hein Bekker. Licensed under the BSD 3-Clause License.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=2.7
Description-Content-Type: text/markdown
