colorir


Namecolorir JSON
Version 2.0.5 PyPI version JSON
download
home_pagehttps://github.com/aleferna12/colorir
SummaryA python package for easy management of colors and palettes.
upload_time2024-09-08 03:33:23
maintainerNone
docs_urlNone
authoraleferna
requires_python>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Colorir
=======

.. image:: docs/source/_static/image/readme_palette_picker.png
    :width: 800px

What is colorir?
----------------

colorir is a package used to create and manipulate color palettes.

Main features
-------------

- Create color schemes and save them to use in different projects
- Interpolate colors in different formats (such as RGB, CIELab etc) to make gradients and color maps
- Have access to a curated selection of unique color palettes and color names
- Easily visualize swatches of colors in the terminal


Getting started
---------------

It is very easy to create an original and attractive color palette with colorir:

.. code-block:: python

    import colorir as cl
    grad = cl.PolarGrad(["ffff00", "ff00ff"])  # Creates a gradient from yellow to magenta
    palette = cl.StackPalette(grad.n_colors(5))  # Samples 5 colors along the gradient and creates a palette with them
    palette *= cl.HCLab(1, 0.5, 1)  # Desaturates the palette 50% to get a more pleasing look
    cl.swatch(palette)  # Shows the palette we created in the terminal

.. image:: docs/source/_static/image/readme_palette.png

colorir also works seamlessly with other python packages and you don't have to convert colorir objects to pass
them as input to other frameworks:

.. code-block:: python

    import matplotlib.pyplot as plt

    plt.pie([0.25, 0.15, 0.20, 0.20, 0.20], colors=palette)
    plt.show()

.. image:: docs/source/_static/image/readme_pie_chart.png
    :width: 300px

For more information (including use-cases and examples), see colorir's documentation `here <https://colorir.readthedocs.io/en/latest/>`_.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/aleferna12/colorir",
    "name": "colorir",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "aleferna",
    "author_email": "alexandrepchfernandes@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/47/91/0a360a2c58833f2851bfed4179cd9551dac0f02839b6d3db37f54dd5ab77/colorir-2.0.5.tar.gz",
    "platform": null,
    "description": "Colorir\r\n=======\r\n\r\n.. image:: docs/source/_static/image/readme_palette_picker.png\r\n    :width: 800px\r\n\r\nWhat is colorir?\r\n----------------\r\n\r\ncolorir is a package used to create and manipulate color palettes.\r\n\r\nMain features\r\n-------------\r\n\r\n- Create color schemes and save them to use in different projects\r\n- Interpolate colors in different formats (such as RGB, CIELab etc) to make gradients and color maps\r\n- Have access to a curated selection of unique color palettes and color names\r\n- Easily visualize swatches of colors in the terminal\r\n\r\n\r\nGetting started\r\n---------------\r\n\r\nIt is very easy to create an original and attractive color palette with colorir:\r\n\r\n.. code-block:: python\r\n\r\n    import colorir as cl\r\n    grad = cl.PolarGrad([\"ffff00\", \"ff00ff\"])  # Creates a gradient from yellow to magenta\r\n    palette = cl.StackPalette(grad.n_colors(5))  # Samples 5 colors along the gradient and creates a palette with them\r\n    palette *= cl.HCLab(1, 0.5, 1)  # Desaturates the palette 50% to get a more pleasing look\r\n    cl.swatch(palette)  # Shows the palette we created in the terminal\r\n\r\n.. image:: docs/source/_static/image/readme_palette.png\r\n\r\ncolorir also works seamlessly with other python packages and you don't have to convert colorir objects to pass\r\nthem as input to other frameworks:\r\n\r\n.. code-block:: python\r\n\r\n    import matplotlib.pyplot as plt\r\n\r\n    plt.pie([0.25, 0.15, 0.20, 0.20, 0.20], colors=palette)\r\n    plt.show()\r\n\r\n.. image:: docs/source/_static/image/readme_pie_chart.png\r\n    :width: 300px\r\n\r\nFor more information (including use-cases and examples), see colorir's documentation `here <https://colorir.readthedocs.io/en/latest/>`_.\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A python package for easy management of colors and palettes.",
    "version": "2.0.5",
    "project_urls": {
        "Documentation": "https://colorir.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/aleferna12/colorir"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b19b15e8f447c7e6a292df3105a0a15362e4eb70d6a9eaff2ced096dd5c7092d",
                "md5": "d6fbe937dff84fbad30c010b20c3be8c",
                "sha256": "5c6fc8e4e0f40e6cb0d86183f66f25d38d95864cb4cb8fa1ad0be9d04da167e8"
            },
            "downloads": -1,
            "filename": "colorir-2.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d6fbe937dff84fbad30c010b20c3be8c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 135869,
            "upload_time": "2024-09-08T03:33:21",
            "upload_time_iso_8601": "2024-09-08T03:33:21.382862Z",
            "url": "https://files.pythonhosted.org/packages/b1/9b/15e8f447c7e6a292df3105a0a15362e4eb70d6a9eaff2ced096dd5c7092d/colorir-2.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "47910a360a2c58833f2851bfed4179cd9551dac0f02839b6d3db37f54dd5ab77",
                "md5": "a169524da3205fd08139629d3ad18f9d",
                "sha256": "00db51e2211798f5b3bd0836b1a9abfe506eb98981e1fa680eb0d4ff9b7bbf25"
            },
            "downloads": -1,
            "filename": "colorir-2.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "a169524da3205fd08139629d3ad18f9d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 107304,
            "upload_time": "2024-09-08T03:33:23",
            "upload_time_iso_8601": "2024-09-08T03:33:23.142319Z",
            "url": "https://files.pythonhosted.org/packages/47/91/0a360a2c58833f2851bfed4179cd9551dac0f02839b6d3db37f54dd5ab77/colorir-2.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-08 03:33:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "aleferna12",
    "github_project": "colorir",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "colorir"
}
        
Elapsed time: 0.73633s