/usr/lib/python3/dist-packages/colour-0.1.5.egg-info/PKG-INFO is in python3-colour 0.1.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 | Metadata-Version: 1.1
Name: colour
Version: 0.1.5
Summary: converts and manipulates various color representation (HSL, RVB, web, X11, ...)
Home-page: http://github.com/vaab/colour
Author: Valentin LAB
Author-email: valentin.lab@kalysto.org
License: BSD 3-Clause License
Description-Content-Type: UNKNOWN
Description: ======
Colour
======
.. image:: http://img.shields.io/pypi/v/colour.svg?style=flat
:target: https://pypi.python.org/pypi/colour/
:alt: Latest PyPI version
.. image:: https://img.shields.io/pypi/l/gitchangelog.svg?style=flat
:target: https://github.com/vaab/gitchangelog/blob/master/LICENSE
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/gitchangelog.svg?style=flat
:target: https://pypi.python.org/pypi/gitchangelog/
:alt: Compatible python versions
.. image:: http://img.shields.io/pypi/dm/colour.svg?style=flat
:target: https://pypi.python.org/pypi/colour/
:alt: Number of PyPI downloads
.. image:: http://img.shields.io/travis/vaab/colour/master.svg?style=flat
:target: https://travis-ci.org/vaab/colour/
:alt: Travis CI build status
.. image:: https://img.shields.io/appveyor/ci/vaab/colour.svg
:target: https://ci.appveyor.com/project/vaab/colour/branch/master
:alt: Appveyor CI build status
.. image:: http://img.shields.io/codecov/c/github/vaab/colour.svg?style=flat
:target: https://codecov.io/gh/vaab/colour/
:alt: Test coverage
Converts and manipulates common color representation (RGB, HSL, web, ...)
Feature
=======
- Damn simple and pythonic way to manipulate color representation (see
examples below)
- Full conversion between RGB, HSL, 6-digit hex, 3-digit hex, human color
- One object (``Color``) or bunch of single purpose function (``rgb2hex``,
``hsl2rgb`` ...)
- ``web`` format that use the smallest representation between
6-digit (e.g. ``#fa3b2c``), 3-digit (e.g. ``#fbb``), fully spelled
color (e.g. ``white``), following `W3C color naming`_ for compatible
CSS or HTML color specifications.
- smooth intuitive color scale generation choosing N color gradients.
- can pick colors for you to identify objects of your application.
.. _W3C color naming: http://www.w3.org/TR/css3-color/#svg-color
Installation
============
You don't need to download the GIT version of the code as ``colour`` is
available on the PyPI. So you should be able to run::
pip install colour
If you have downloaded the GIT sources, then you could add the ``colour.py``
directly to one of your ``site-packages`` (thanks to a symlink). Or install
the current version via traditional::
python setup.py install
And if you don't have the GIT sources but would like to get the latest
master or branch from github, you could also::
pip install git+https://github.com/vaab/colour
Or even select a specific revision (branch/tag/commit)::
pip install git+https://github.com/vaab/colour@master
Usage
=====
To get complete demo of each function, please read the source code which is
heavily documented and provide a lot of examples in doctest format.
Here is a reduced sample of a common usage scenario:
Instantiation
-------------
Let's create blue color::
>>> from colour import Color
>>> c = Color("blue")
>>> c
<Color blue>
Please note that all of these are equivalent examples to create the red color::
Color("red") ## human, web compatible representation
Color(red=1) ## default amount of blue and green is 0.0
Color("blue", hue=0) ## hue of blue is 0.66, hue of red is 0.0
Color("#f00") ## standard 3 hex digit web compatible representation
Color("#ff0000") ## standard 6 hex digit web compatible representation
Color(hue=0, saturation=1, luminance=0.5)
Color(hsl=(0, 1, 0.5)) ## full 3-uple HSL specification
Color(rgb=(1, 0, 0)) ## full 3-uple RGB specification
Color(Color("red")) ## recursion doesn't break object
Reading values
--------------
Several representations are accessible::
>>> c.hex
'#00f'
>>> c.hsl # doctest: +ELLIPSIS
(0.66..., 1.0, 0.5)
>>> c.rgb
(0.0, 0.0, 1.0)
And their different parts are also independently accessible, as the different
amount of red, blue, green, in the RGB format::
>>> c.red
0.0
>>> c.blue
1.0
>>> c.green
0.0
Or the hue, saturation and luminance of the HSL representation::
>>> c.hue # doctest: +ELLIPSIS
0.66...
>>> c.saturation
1.0
>>> c.luminance
0.5
A note on the ``.hex`` property, it'll return the smallest valid value
when possible. If you are only interested by the long value, use
``.hex_l``::
>>> c.hex_l
'#0000ff'
Modifying color objects
-----------------------
All of these properties are read/write, so let's add some red to this color::
>>> c.red = 1
>>> c
<Color magenta>
We might want to de-saturate this color::
>>> c.saturation = 0.5
>>> c
<Color #bf40bf>
And of course, the string conversion will give the web representation which is
human, or 3-digit, or 6-digit hex representation depending which is usable::
>>> "%s" % c
'#bf40bf'
>>> c.luminance = 1
>>> "%s" % c
'white'
Ranges of colors
----------------
You can get some color scale of variation between two ``Color`` objects quite
easily. Here, is the color scale of the rainbow between red and blue::
>>> red = Color("red")
>>> blue = Color("blue")
>>> list(red.range_to(blue, 5))
[<Color red>, <Color yellow>, <Color lime>, <Color cyan>, <Color blue>]
Or the different amount of gray between black and white::
>>> black = Color("black")
>>> white = Color("white")
>>> list(black.range_to(white, 6))
[<Color black>, <Color #333>, <Color #666>, <Color #999>, <Color #ccc>, <Color white>]
If you have to create graphical representation with color scale
between red and green ('lime' color is full green)::
>>> lime = Color("lime")
>>> list(red.range_to(lime, 5))
[<Color red>, <Color #ff7f00>, <Color yellow>, <Color chartreuse>, <Color lime>]
Notice how naturally, the yellow is displayed in human format and in
the middle of the scale. And that the quite unusual (but compatible)
'chartreuse' color specification has been used in place of the
hexadecimal representation.
Color comparison
----------------
Sane default
~~~~~~~~~~~~
Color comparison is a vast subject. However, it might seem quite straightforward for
you. ``Colour`` uses a configurable default way of comparing color that might suit
your needs::
>>> Color("red") == Color("#f00") == Color("blue", hue=0)
True
The default comparison algorithm focuses only on the "web" representation which is
equivalent to comparing the long hex representation (e.g. #FF0000) or to be more
specific, it is equivalent to compare the amount of red, green, and blue composition
of the RGB representation, each of these value being quantized to a 256 value scale.
This default comparison is a practical and convenient way to measure the actual
color equivalence on your screen, or in your video card memory.
But this comparison wouldn't make the difference between a black red, and a
black blue, which both are black::
>>> black_red = Color("red", luminance=0)
>>> black_blue = Color("blue", luminance=0)
>>> black_red == black_blue
True
Customization
~~~~~~~~~~~~~
But, this is not the sole way to compare two colors. As I'm quite lazy, I'm providing
you a way to customize it to your needs. Thus::
>>> from colour import RGB_equivalence, HSL_equivalence
>>> black_red = Color("red", luminance=0, equality=HSL_equivalence)
>>> black_blue = Color("blue", luminance=0, equality=HSL_equivalence)
>>> black_red == black_blue
False
As you might have already guessed, the sane default is ``RGB_equivalence``, so::
>>> black_red = Color("red", luminance=0, equality=RGB_equivalence)
>>> black_blue = Color("blue", luminance=0, equality=RGB_equivalence)
>>> black_red == black_blue
True
Here's how you could implement your unique comparison function::
>>> saturation_equivalence = lambda c1, c2: c1.saturation == c2.saturation
>>> red = Color("red", equality=saturation_equivalence)
>>> blue = Color("blue", equality=saturation_equivalence)
>>> white = Color("white", equality=saturation_equivalence)
>>> red == blue
True
>>> white == red
False
Note: When comparing 2 colors, *only* the equality function *of the first
color will be used*. Thus::
>>> black_red = Color("red", luminance=0, equality=RGB_equivalence)
>>> black_blue = Color("blue", luminance=0, equality=HSL_equivalence)
>>> black_red == black_blue
True
But reverse operation is not equivalent !::
>>> black_blue == black_red
False
Equality to non-Colour objects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
As a side note, whatever your custom equality function is, it won't be
used if you compare to anything else than a ``Colour`` instance::
>>> red = Color("red", equality=lambda c1, c2: True)
>>> blue = Color("blue", equality=lambda c1, c2: True)
Note that these instances would compare as equal to any other color::
>>> red == blue
True
But on another non-Colour object::
>>> red == None
False
>>> red != None
True
Actually, ``Colour`` instances will, politely enough, leave
the other side of the equality have a chance to decide of the output,
(by executing its own ``__eq__``), so::
>>> class OtherColorImplem(object):
... def __init__(self, color):
... self.color = color
... def __eq__(self, other):
... return self.color == other.web
>>> alien_red = OtherColorImplem("red")
>>> red == alien_red
True
>>> blue == alien_red
False
And inequality (using ``__ne__``) are also polite::
>>> class AnotherColorImplem(OtherColorImplem):
... def __ne__(self, other):
... return self.color != other.web
>>> new_alien_red = AnotherColorImplem("red")
>>> red != new_alien_red
False
>>> blue != new_alien_red
True
Picking arbitrary color for a python object
-------------------------------------------
Basic Usage
~~~~~~~~~~~
Sometimes, you just want to pick a color for an object in your application
often to visually identify this object. Thus, the picked color should be the
same for same objects, and different for different object::
>>> foo = object()
>>> bar = object()
>>> Color(pick_for=foo) # doctest: +ELLIPSIS
<Color ...>
>>> Color(pick_for=foo) == Color(pick_for=foo)
True
>>> Color(pick_for=foo) == Color(pick_for=bar)
False
Of course, although there's a tiny probability that different strings yield the
same color, most of the time, different inputs will produce different colors.
Advanced Usage
~~~~~~~~~~~~~~
You can customize your color picking algorithm by providing a ``picker``. A
``picker`` is a callable that takes an object, and returns something that can
be instantiated as a color by ``Color``::
>>> my_picker = lambda obj: "red" if isinstance(obj, int) else "blue"
>>> Color(pick_for=3, picker=my_picker, pick_key=None)
<Color red>
>>> Color(pick_for="foo", picker=my_picker, pick_key=None)
<Color blue>
You might want to use a particular picker, but enforce how the picker will
identify two object as the same (or not). So there's a ``pick_key`` attribute
that is provided and defaults as equivalent of ``hash`` method and if hash is
not supported by your object, it'll default to the ``str`` of your object salted
with the class name.
Thus::
>>> class MyObj(str): pass
>>> my_obj_color = Color(pick_for=MyObj("foo"))
>>> my_str_color = Color(pick_for="foo")
>>> my_obj_color == my_str_color
False
Please make sure your object is hashable or "stringable" before using the
``RGB_color_picker`` picking mechanism or provide another color picker. Nearly
all python object are hashable by default so this shouldn't be an issue (e.g.
instances of ``object`` and subclasses are hashable).
Neither ``hash`` nor ``str`` are perfect solution. So feel free to use
``pick_key`` at ``Color`` instantiation time to set your way to identify
objects, for instance::
>>> a = object()
>>> b = object()
>>> Color(pick_for=a, pick_key=id) == Color(pick_for=b, pick_key=id)
False
When choosing a pick key, you should closely consider if you want your color
to be consistent between runs (this is NOT the case with the last example),
or consistent with the content of your object if it is a mutable object.
Default value of ``pick_key`` and ``picker`` ensures that the same color will
be attributed to same object between different run on different computer for
most python object.
Color factory
-------------
As you might have noticed, there are few attributes that you might want to see
attached to all of your colors as ``equality`` for equality comparison support,
or ``picker``, ``pick_key`` to configure your object color picker.
You can create a customized ``Color`` factory thanks to the ``make_color_factory``::
>>> from colour import make_color_factory, HSL_equivalence, RGB_color_picker
>>> get_color = make_color_factory(
... equality=HSL_equivalence,
... picker=RGB_color_picker,
... pick_key=str,
... )
All color created thanks to ``CustomColor`` class instead of the default one
would get the specified attributes by default::
>>> black_red = get_color("red", luminance=0)
>>> black_blue = get_color("blue", luminance=0)
Of course, these are always instances of ``Color`` class::
>>> isinstance(black_red, Color)
True
Equality was changed from normal defaults, so::
>>> black_red == black_blue
False
This because the default equivalence of ``Color`` was set to
``HSL_equivalence``.
Contributing
============
Any suggestion or issue is welcome. Push request are very welcome,
please check out the guidelines.
Push Request Guidelines
-----------------------
You can send any code. I'll look at it and will integrate it myself in
the code base and leave you as the author. This process can take time and
it'll take less time if you follow the following guidelines:
- check your code with PEP8 or pylint. Try to stick to 80 columns wide.
- separate your commits per smallest concern.
- each commit should pass the tests (to allow easy bisect)
- each functionality/bugfix commit should contain the code, tests,
and doc.
- prior minor commit with typographic or code cosmetic changes are
very welcome. These should be tagged in their commit summary with
``!minor``.
- the commit message should follow gitchangelog rules (check the git
log to get examples)
- if the commit fixes an issue or finished the implementation of a
feature, please mention it in the summary.
If you have some questions about guidelines which is not answered here,
please check the current ``git log``, you might find previous commit that
would show you how to deal with your issue.
License
=======
Copyright (c) 2012-2017 Valentin Lab.
Licensed under the `BSD License`_.
.. _BSD License: http://raw.github.com/vaab/colour/master/LICENSE
Changelog
=========
0.1.4 (2017-04-19)
------------------
Fix
~~~
- ``rgb2hsl`` would produce invalid hsl triplet when red, blue, green
component would be all very close to ``1.0``. (fixes #30) [Valentin
Lab]
Typically, saturation would shoot out of range 0.0..1.0. That could then
lead to exceptions being casts afterwards when trying to reconvert this
HSL triplet to RGB values.
0.1.3 (2017-04-08)
------------------
Fix
~~~
- Unexpected behavior with ``!=`` operator. (fixes #26) [Valentin Lab]
- Added mention of the ``hex_l`` property. (fixes #27) [Valentin Lab]
0.1.2 (2015-09-15)
------------------
Fix
~~~
- Support for corner case 1-wide ``range_to`` color scale. (fixes #18)
[Valentin Lab]
0.1.1 (2015-03-29)
------------------
Fix
~~~
- Avoid casting an exception when comparing to non-``Colour`` instances.
(fixes #14) [Riziq Sayegh]
0.0.6 (2014-11-18)
------------------
New
~~~
- Provide all missing *2* function by combination with other existing
ones (fixes #13). [Valentin Lab]
- Provide full access to any color name in HSL, RGB, HEX convenience
instances. [Valentin Lab]
Now you can call ``colour.HSL.cyan``, or ``colour.HEX.red`` for a direct encoding of
``human`` colour labels to the 3 representations.
0.0.5 (2013-09-16)
------------------
New
~~~
- Color names are case insensitive. [Chris Priest]
The color-name structure have their names capitalized. And color names
that are made of only one word will be displayed lowercased.
Fix
~~~
- Now using W3C color recommandation. [Chris Priest]
Was using X11 color scheme before, which is slightly different from
W3C web color specifications.
- Inconsistency in licence information (removed GPL mention). (fixes #8)
[Valentin Lab]
- Removed ``gitchangelog`` from ``setup.py`` require list. (fixes #9)
[Valentin Lab]
0.0.4 (2013-06-21)
------------------
New
~~~
- Added ``make_color_factory`` to customize some common color
attributes. [Valentin Lab]
- Pick color to identify any python object (fixes #6) [Jonathan Ballet]
- Equality support between colors, customizable if needed. (fixes #3)
[Valentin Lab]
0.0.3 (2013-06-19)
------------------
New
~~~
- Colour is now compatible with python3. [Ryan Leckey]
0.0.1 (2012-06-11)
------------------
- First import. [Valentin Lab]
TODO
====
- ANSI 16-color and 256-color escape sequence generation
- YUV, HSV, CMYK support
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
|