colour.utilities.describe_environment

colour.utilities.describe_environment(runtime_packages=True, development_packages=False, print_environment=True, **kwargs)

Describes Colour running environment, i.e. interpreter, runtime and development packages.

Parameters:

• runtime_packages (bool, optional) – Whether to return the runtime packages versions.
• development_packages (bool, optional) – Whether to return the development packages versions.
• print_environment (bool, optional) – Whether to print the environment.

Other Parameters:  

• padding (unicode, optional) – {colour.utilities.message_box()}, Padding on each sides of the message.
• print_callable (callable, optional) – {colour.utilities.message_box()}, Callable used to print the message box.
• width (int, optional) – {colour.utilities.message_box()}, Message box width.

Returns:

Environment.

Return type:

defaultdict

Examples

>>> environment = describe_environment(width=75)  # doctest: +SKIP
===========================================================================
*                                                                         *
*   Interpreter :                                                         *
*       python : 2.7.14 | packaged by conda-forge | (default, Dec 25      *
*   2017, 01:18:54)                                                       *
*                [GCC 4.2.1 Compatible Apple LLVM 6.1.0                   *
*   (clang-602.0.53)]                                                     *
*                                                                         *
*   colour-science.org :                                                  *
*       colour : v0.3.11-323-g380c1838                                    *
*                                                                         *
*   Runtime :                                                             *
*       numpy : 1.14.3                                                    *
*       scipy : 1.0.0                                                     *
*       pandas : 0.22.0                                                   *
*       matplotlib : 2.2.2                                                *
*       notebook : 5.4.0                                                  *
*       ipywidgets : 7.2.1                                                *
*                                                                         *
===========================================================================
>>> environment = describe_environment(True, True, width=75)
... # doctest: +SKIP
===========================================================================
*                                                                         *
*   Interpreter :                                                         *
*       python : 2.7.14 | packaged by conda-forge | (default, Dec 25      *
*   2017, 01:18:54)                                                       *
*                [GCC 4.2.1 Compatible Apple LLVM 6.1.0                   *
*   (clang-602.0.53)]                                                     *
*                                                                         *
*   colour-science.org :                                                  *
*       colour : v0.3.11-323-g380c1838                                    *
*                                                                         *
*   Runtime :                                                             *
*       numpy : 1.14.3                                                    *
*       scipy : 1.0.0                                                     *
*       pandas : 0.22.0                                                   *
*       matplotlib : 2.2.2                                                *
*       notebook : 5.4.0                                                  *
*       ipywidgets : 7.2.1                                                *
*                                                                         *
*   Development :                                                         *
*       coverage : 4.5.1                                                  *
*       flake8 : 3.5.0                                                    *
*       invoke : 0.22.1                                                   *
*       mock : 2.0.0                                                      *
*       nose : 1.3.7                                                      *
*       restructuredtext_lint : 1.1.3                                     *
*       six : 1.11.0                                                      *
*       sphinx : 1.7.5                                                    *
*       sphinx_rtd_theme : 0.2.4                                          *
*       twine : 1.10.0                                                    *
*       yapf : 0.20.2                                                     *
*                                                                         *
===========================================================================