hnUHfYZUmKMO


NamehnUHfYZUmKMO JSON
Version 0.3.2 PyPI version JSON
download
home_pagehttps://github.com/tartley/hnUHfYZUmKMO
SummaryCross-platform colored terminal text.
upload_time2023-07-20 21:37:13
maintainerArnon Yaari
docs_urlNone
authorJonathan Hartley
requires_python>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
licenseBSD
keywords color colour terminal text ansi windows crossplatform xplatform
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://img.shields.io/pypi/v/colorama.svg
    :target: https://pypi.org/project/colorama/
    :alt: Latest Version

.. image:: https://img.shields.io/pypi/pyversions/colorama.svg
    :target: https://pypi.org/project/colorama/
    :alt: Supported Python versions

.. image:: https://travis-ci.org/tartley/colorama.svg?branch=master
    :target: https://travis-ci.org/tartley/colorama
    :alt: Build Status

Download and docs:
    https://pypi.org/project/colorama/
Source code & Development:
    https://github.com/tartley/colorama
Colorama for Enterprise:
    https://github.com/tartley/colorama/blob/master/ENTERPRISE.md

Description
===========

Makes ANSI escape character sequences (for producing colored terminal text and
cursor positioning) work under MS Windows.

ANSI escape character sequences have long been used to produce colored terminal
text and cursor positioning on Unix and Macs. Colorama makes this work on
Windows, too, by wrapping ``stdout``, stripping ANSI sequences it finds (which
would appear as gobbledygook in the output), and converting them into the
appropriate win32 calls to modify the state of the terminal. On other platforms,
Colorama does nothing.

Colorama also provides some shortcuts to help generate ANSI sequences
but works fine in conjunction with any other ANSI sequence generation library,
such as the venerable Termcolor (https://pypi.org/project/termcolor/)
or the fabulous Blessings (https://pypi.org/project/blessings/).

This has the upshot of providing a simple cross-platform API for printing
colored terminal text from Python, and has the happy side-effect that existing
applications or libraries which use ANSI sequences to produce colored output on
Linux or Macs can now also work on Windows, simply by calling
``colorama.init()``.

An alternative approach is to install ``ansi.sys`` on Windows machines, which
provides the same behaviour for all applications running in terminals. Colorama
is intended for situations where that isn't easy (e.g., maybe your app doesn't
have an installer.)

Demo scripts in the source code repository print some colored text using
ANSI sequences. Compare their output under Gnome-terminal's built in ANSI
handling, versus on Windows Command-Prompt using Colorama:

.. image:: https://github.com/tartley/colorama/raw/master/screenshots/ubuntu-demo.png
    :width: 661
    :height: 357
    :alt: ANSI sequences on Ubuntu under gnome-terminal.

.. image:: https://github.com/tartley/colorama/raw/master/screenshots/windows-demo.png
    :width: 668
    :height: 325
    :alt: Same ANSI sequences on Windows, using Colorama.

These screengrabs show that, on Windows, Colorama does not support ANSI 'dim
text'; it looks the same as 'normal text'.


License
=======

Copyright Jonathan Hartley & Arnon Yaari, 2013. BSD 3-Clause license; see LICENSE file.


Dependencies
============

None, other than Python. Tested on Python 2.7, 3.5, 3.6, 3.7 and 3.8.

Usage
=====

Initialisation
--------------

Applications should initialise Colorama using:

.. code-block:: python

    from colorama import init
    init()

On Windows, calling ``init()`` will filter ANSI escape sequences out of any
text sent to ``stdout`` or ``stderr``, and replace them with equivalent Win32
calls.

On other platforms, calling ``init()`` has no effect (unless you request other
optional functionality; see "Init Keyword Args", below). By design, this permits
applications to call ``init()`` unconditionally on all platforms, after which
ANSI output should just work.

To stop using colorama before your program exits, simply call ``deinit()``.
This will restore ``stdout`` and ``stderr`` to their original values, so that
Colorama is disabled. To resume using Colorama again, call ``reinit()``; it is
cheaper to calling ``init()`` again (but does the same thing).


Colored Output
--------------

Cross-platform printing of colored text can then be done using Colorama's
constant shorthand for ANSI escape sequences:

.. code-block:: python

    from colorama import Fore, Back, Style
    print(Fore.RED + 'some red text')
    print(Back.GREEN + 'and with a green background')
    print(Style.DIM + 'and in dim text')
    print(Style.RESET_ALL)
    print('back to normal now')

...or simply by manually printing ANSI sequences from your own code:

.. code-block:: python

    print('\033[31m' + 'some red text')
    print('\033[39m') # and reset to default color

...or, Colorama can be used happily in conjunction with existing ANSI libraries
such as Termcolor:

.. code-block:: python

    from colorama import init
    from termcolor import colored

    # use Colorama to make Termcolor work on Windows too
    init()

    # then use Termcolor for all colored text output
    print(colored('Hello, World!', 'green', 'on_red'))

Available formatting constants are::

    Fore: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET.
    Back: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET.
    Style: DIM, NORMAL, BRIGHT, RESET_ALL

``Style.RESET_ALL`` resets foreground, background, and brightness. Colorama will
perform this reset automatically on program exit.


Cursor Positioning
------------------

ANSI codes to reposition the cursor are supported. See ``demos/demo06.py`` for
an example of how to generate them.


Init Keyword Args
-----------------

``init()`` accepts some ``**kwargs`` to override default behaviour.

init(autoreset=False):
    If you find yourself repeatedly sending reset sequences to turn off color
    changes at the end of every print, then ``init(autoreset=True)`` will
    automate that:

    .. code-block:: python

        from colorama import init
        init(autoreset=True)
        print(Fore.RED + 'some red text')
        print('automatically back to default color again')

init(strip=None):
    Pass ``True`` or ``False`` to override whether ansi codes should be
    stripped from the output. The default behaviour is to strip if on Windows
    or if output is redirected (not a tty).

init(convert=None):
    Pass ``True`` or ``False`` to override whether to convert ANSI codes in the
    output into win32 calls. The default behaviour is to convert if on Windows
    and output is to a tty (terminal).

init(wrap=True):
    On Windows, colorama works by replacing ``sys.stdout`` and ``sys.stderr``
    with proxy objects, which override the ``.write()`` method to do their work.
    If this wrapping causes you problems, then this can be disabled by passing
    ``init(wrap=False)``. The default behaviour is to wrap if ``autoreset`` or
    ``strip`` or ``convert`` are True.

    When wrapping is disabled, colored printing on non-Windows platforms will
    continue to work as normal. To do cross-platform colored output, you can
    use Colorama's ``AnsiToWin32`` proxy directly:

    .. code-block:: python

        import sys
        from colorama import init, AnsiToWin32
        init(wrap=False)
        stream = AnsiToWin32(sys.stderr).stream

        # Python 2
        print >>stream, Fore.BLUE + 'blue text on stderr'

        # Python 3
        print(Fore.BLUE + 'blue text on stderr', file=stream)


Installation
=======================
colorama is currently installable from PyPI:

    pip install colorama
    
colorama also can be installed by the conda package manager:

    conda install -c anaconda colorama 


Status & Known Problems
=======================

I've personally only tested it on Windows XP (CMD, Console2), Ubuntu
(gnome-terminal, xterm), and OS X.

Some presumably valid ANSI sequences aren't recognised (see details below),
but to my knowledge nobody has yet complained about this. Puzzling.

See outstanding issues and wishlist:
https://github.com/tartley/colorama/issues

If anything doesn't work for you, or doesn't do what you expected or hoped for,
I'd love to hear about it on that issues list, would be delighted by patches,
and would be happy to grant commit access to anyone who submits a working patch
or two.


Recognised ANSI Sequences
=========================

ANSI sequences generally take the form:

    ESC [ <param> ; <param> ... <command>

Where ``<param>`` is an integer, and ``<command>`` is a single letter. Zero or
more params are passed to a ``<command>``. If no params are passed, it is
generally synonymous with passing a single zero. No spaces exist in the
sequence; they have been inserted here simply to read more easily.

The only ANSI sequences that colorama converts into win32 calls are::

    ESC [ 0 m       # reset all (colors and brightness)
    ESC [ 1 m       # bright
    ESC [ 2 m       # dim (looks same as normal brightness)
    ESC [ 22 m      # normal brightness

    # FOREGROUND:
    ESC [ 30 m      # black
    ESC [ 31 m      # red
    ESC [ 32 m      # green
    ESC [ 33 m      # yellow
    ESC [ 34 m      # blue
    ESC [ 35 m      # magenta
    ESC [ 36 m      # cyan
    ESC [ 37 m      # white
    ESC [ 39 m      # reset

    # BACKGROUND
    ESC [ 40 m      # black
    ESC [ 41 m      # red
    ESC [ 42 m      # green
    ESC [ 43 m      # yellow
    ESC [ 44 m      # blue
    ESC [ 45 m      # magenta
    ESC [ 46 m      # cyan
    ESC [ 47 m      # white
    ESC [ 49 m      # reset

    # cursor positioning
    ESC [ y;x H     # position cursor at x across, y down
    ESC [ y;x f     # position cursor at x across, y down
    ESC [ n A       # move cursor n lines up
    ESC [ n B       # move cursor n lines down
    ESC [ n C       # move cursor n characters forward
    ESC [ n D       # move cursor n characters backward

    # clear the screen
    ESC [ mode J    # clear the screen

    # clear the line
    ESC [ mode K    # clear the line

Multiple numeric params to the ``'m'`` command can be combined into a single
sequence::

    ESC [ 36 ; 45 ; 1 m     # bright cyan text on magenta background

All other ANSI sequences of the form ``ESC [ <param> ; <param> ... <command>``
are silently stripped from the output on Windows.

Any other form of ANSI sequence, such as single-character codes or alternative
initial characters, are not recognised or stripped. It would be cool to add
them though. Let me know if it would be useful for you, via the Issues on
GitHub.


Development
===========

Help and fixes welcome!

Running tests requires:

- Michael Foord's ``mock`` module to be installed.
- Tests are written using 2010-era updates to ``unittest``

To run tests::

   python -m unittest discover -p *_test.py

This, like a few other handy commands, is captured in a ``Makefile``.

If you use nose to run the tests, you must pass the ``-s`` flag; otherwise,
``nosetests`` applies its own proxy to ``stdout``, which confuses the unit
tests.


Professional support
====================

.. |tideliftlogo| image:: https://cdn2.hubspot.net/hubfs/4008838/website/logos/logos_for_download/Tidelift_primary-shorthand-logo.png
   :alt: Tidelift
   :target: https://tidelift.com/subscription/pkg/pypi-colorama?utm_source=pypi-colorama&utm_medium=referral&utm_campaign=readme

.. list-table::
   :widths: 10 100

   * - |tideliftlogo|
     - Professional support for colorama is available as part of the
       `Tidelift Subscription`_.
       Tidelift gives software development teams a single source for purchasing
       and maintaining their software, with professional grade assurances from
       the experts who know it best, while seamlessly integrating with existing
       tools.

.. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-colorama?utm_source=pypi-colorama&utm_medium=referral&utm_campaign=readme


Thanks
======
* Marc Schlaich (schlamar) for a ``setup.py`` fix for Python2.5.
* Marc Abramowitz, reported & fixed a crash on exit with closed ``stdout``,
  providing a solution to issue #7's setuptools/distutils debate,
  and other fixes.
* User 'eryksun', for guidance on correctly instantiating ``ctypes.windll``.
* Matthew McCormick for politely pointing out a longstanding crash on non-Win.
* Ben Hoyt, for a magnificent fix under 64-bit Windows.
* Jesse at Empty Square for submitting a fix for examples in the README.
* User 'jamessp', an observant documentation fix for cursor positioning.
* User 'vaal1239', Dave Mckee & Lackner Kristof for a tiny but much-needed Win7
  fix.
* Julien Stuyck, for wisely suggesting Python3 compatible updates to README.
* Daniel Griffith for multiple fabulous patches.
* Oscar Lesta for a valuable fix to stop ANSI chars being sent to non-tty
  output.
* Roger Binns, for many suggestions, valuable feedback, & bug reports.
* Tim Golden for thought and much appreciated feedback on the initial idea.
* User 'Zearin' for updates to the README file.
* John Szakmeister for adding support for light colors
* Charles Merriam for adding documentation to demos
* Jurko for a fix on 64-bit Windows CPython2.5 w/o ctypes
* Florian Bruhin for a fix when stdout or stderr are None
* Thomas Weininger for fixing ValueError on Windows
* Remi Rampin for better Github integration and fixes to the README file
* Simeon Visser for closing a file handle using 'with' and updating classifiers
  to include Python 3.3 and 3.4
* Andy Neff for fixing RESET of LIGHT_EX colors.
* Jonathan Hartley for the initial idea and implementation.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tartley/hnUHfYZUmKMO",
    "name": "hnUHfYZUmKMO",
    "maintainer": "Arnon Yaari",
    "docs_url": null,
    "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
    "maintainer_email": "",
    "keywords": "color colour terminal text ansi windows crossplatform xplatform",
    "author": "Jonathan Hartley",
    "author_email": "tartley@tartley.com",
    "download_url": "https://files.pythonhosted.org/packages/20/8e/1cec47b00096754e479faa1a0b2c98f4a1907f119970a60aecb64f1d2a2b/hnUHfYZUmKMO-0.3.2.tar.gz",
    "platform": null,
    "description": ".. image:: https://img.shields.io/pypi/v/colorama.svg\r\n    :target: https://pypi.org/project/colorama/\r\n    :alt: Latest Version\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/colorama.svg\r\n    :target: https://pypi.org/project/colorama/\r\n    :alt: Supported Python versions\r\n\r\n.. image:: https://travis-ci.org/tartley/colorama.svg?branch=master\r\n    :target: https://travis-ci.org/tartley/colorama\r\n    :alt: Build Status\r\n\r\nDownload and docs:\r\n    https://pypi.org/project/colorama/\r\nSource code & Development:\r\n    https://github.com/tartley/colorama\r\nColorama for Enterprise:\r\n    https://github.com/tartley/colorama/blob/master/ENTERPRISE.md\r\n\r\nDescription\r\n===========\r\n\r\nMakes ANSI escape character sequences (for producing colored terminal text and\r\ncursor positioning) work under MS Windows.\r\n\r\nANSI escape character sequences have long been used to produce colored terminal\r\ntext and cursor positioning on Unix and Macs. Colorama makes this work on\r\nWindows, too, by wrapping ``stdout``, stripping ANSI sequences it finds (which\r\nwould appear as gobbledygook in the output), and converting them into the\r\nappropriate win32 calls to modify the state of the terminal. On other platforms,\r\nColorama does nothing.\r\n\r\nColorama also provides some shortcuts to help generate ANSI sequences\r\nbut works fine in conjunction with any other ANSI sequence generation library,\r\nsuch as the venerable Termcolor (https://pypi.org/project/termcolor/)\r\nor the fabulous Blessings (https://pypi.org/project/blessings/).\r\n\r\nThis has the upshot of providing a simple cross-platform API for printing\r\ncolored terminal text from Python, and has the happy side-effect that existing\r\napplications or libraries which use ANSI sequences to produce colored output on\r\nLinux or Macs can now also work on Windows, simply by calling\r\n``colorama.init()``.\r\n\r\nAn alternative approach is to install ``ansi.sys`` on Windows machines, which\r\nprovides the same behaviour for all applications running in terminals. Colorama\r\nis intended for situations where that isn't easy (e.g., maybe your app doesn't\r\nhave an installer.)\r\n\r\nDemo scripts in the source code repository print some colored text using\r\nANSI sequences. Compare their output under Gnome-terminal's built in ANSI\r\nhandling, versus on Windows Command-Prompt using Colorama:\r\n\r\n.. image:: https://github.com/tartley/colorama/raw/master/screenshots/ubuntu-demo.png\r\n    :width: 661\r\n    :height: 357\r\n    :alt: ANSI sequences on Ubuntu under gnome-terminal.\r\n\r\n.. image:: https://github.com/tartley/colorama/raw/master/screenshots/windows-demo.png\r\n    :width: 668\r\n    :height: 325\r\n    :alt: Same ANSI sequences on Windows, using Colorama.\r\n\r\nThese screengrabs show that, on Windows, Colorama does not support ANSI 'dim\r\ntext'; it looks the same as 'normal text'.\r\n\r\n\r\nLicense\r\n=======\r\n\r\nCopyright Jonathan Hartley & Arnon Yaari, 2013. BSD 3-Clause license; see LICENSE file.\r\n\r\n\r\nDependencies\r\n============\r\n\r\nNone, other than Python. Tested on Python 2.7, 3.5, 3.6, 3.7 and 3.8.\r\n\r\nUsage\r\n=====\r\n\r\nInitialisation\r\n--------------\r\n\r\nApplications should initialise Colorama using:\r\n\r\n.. code-block:: python\r\n\r\n    from colorama import init\r\n    init()\r\n\r\nOn Windows, calling ``init()`` will filter ANSI escape sequences out of any\r\ntext sent to ``stdout`` or ``stderr``, and replace them with equivalent Win32\r\ncalls.\r\n\r\nOn other platforms, calling ``init()`` has no effect (unless you request other\r\noptional functionality; see \"Init Keyword Args\", below). By design, this permits\r\napplications to call ``init()`` unconditionally on all platforms, after which\r\nANSI output should just work.\r\n\r\nTo stop using colorama before your program exits, simply call ``deinit()``.\r\nThis will restore ``stdout`` and ``stderr`` to their original values, so that\r\nColorama is disabled. To resume using Colorama again, call ``reinit()``; it is\r\ncheaper to calling ``init()`` again (but does the same thing).\r\n\r\n\r\nColored Output\r\n--------------\r\n\r\nCross-platform printing of colored text can then be done using Colorama's\r\nconstant shorthand for ANSI escape sequences:\r\n\r\n.. code-block:: python\r\n\r\n    from colorama import Fore, Back, Style\r\n    print(Fore.RED + 'some red text')\r\n    print(Back.GREEN + 'and with a green background')\r\n    print(Style.DIM + 'and in dim text')\r\n    print(Style.RESET_ALL)\r\n    print('back to normal now')\r\n\r\n...or simply by manually printing ANSI sequences from your own code:\r\n\r\n.. code-block:: python\r\n\r\n    print('\\033[31m' + 'some red text')\r\n    print('\\033[39m') # and reset to default color\r\n\r\n...or, Colorama can be used happily in conjunction with existing ANSI libraries\r\nsuch as Termcolor:\r\n\r\n.. code-block:: python\r\n\r\n    from colorama import init\r\n    from termcolor import colored\r\n\r\n    # use Colorama to make Termcolor work on Windows too\r\n    init()\r\n\r\n    # then use Termcolor for all colored text output\r\n    print(colored('Hello, World!', 'green', 'on_red'))\r\n\r\nAvailable formatting constants are::\r\n\r\n    Fore: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET.\r\n    Back: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET.\r\n    Style: DIM, NORMAL, BRIGHT, RESET_ALL\r\n\r\n``Style.RESET_ALL`` resets foreground, background, and brightness. Colorama will\r\nperform this reset automatically on program exit.\r\n\r\n\r\nCursor Positioning\r\n------------------\r\n\r\nANSI codes to reposition the cursor are supported. See ``demos/demo06.py`` for\r\nan example of how to generate them.\r\n\r\n\r\nInit Keyword Args\r\n-----------------\r\n\r\n``init()`` accepts some ``**kwargs`` to override default behaviour.\r\n\r\ninit(autoreset=False):\r\n    If you find yourself repeatedly sending reset sequences to turn off color\r\n    changes at the end of every print, then ``init(autoreset=True)`` will\r\n    automate that:\r\n\r\n    .. code-block:: python\r\n\r\n        from colorama import init\r\n        init(autoreset=True)\r\n        print(Fore.RED + 'some red text')\r\n        print('automatically back to default color again')\r\n\r\ninit(strip=None):\r\n    Pass ``True`` or ``False`` to override whether ansi codes should be\r\n    stripped from the output. The default behaviour is to strip if on Windows\r\n    or if output is redirected (not a tty).\r\n\r\ninit(convert=None):\r\n    Pass ``True`` or ``False`` to override whether to convert ANSI codes in the\r\n    output into win32 calls. The default behaviour is to convert if on Windows\r\n    and output is to a tty (terminal).\r\n\r\ninit(wrap=True):\r\n    On Windows, colorama works by replacing ``sys.stdout`` and ``sys.stderr``\r\n    with proxy objects, which override the ``.write()`` method to do their work.\r\n    If this wrapping causes you problems, then this can be disabled by passing\r\n    ``init(wrap=False)``. The default behaviour is to wrap if ``autoreset`` or\r\n    ``strip`` or ``convert`` are True.\r\n\r\n    When wrapping is disabled, colored printing on non-Windows platforms will\r\n    continue to work as normal. To do cross-platform colored output, you can\r\n    use Colorama's ``AnsiToWin32`` proxy directly:\r\n\r\n    .. code-block:: python\r\n\r\n        import sys\r\n        from colorama import init, AnsiToWin32\r\n        init(wrap=False)\r\n        stream = AnsiToWin32(sys.stderr).stream\r\n\r\n        # Python 2\r\n        print >>stream, Fore.BLUE + 'blue text on stderr'\r\n\r\n        # Python 3\r\n        print(Fore.BLUE + 'blue text on stderr', file=stream)\r\n\r\n\r\nInstallation\r\n=======================\r\ncolorama is currently installable from PyPI:\r\n\r\n    pip install colorama\r\n    \r\ncolorama also can be installed by the conda package manager:\r\n\r\n    conda install -c anaconda colorama \r\n\r\n\r\nStatus & Known Problems\r\n=======================\r\n\r\nI've personally only tested it on Windows XP (CMD, Console2), Ubuntu\r\n(gnome-terminal, xterm), and OS X.\r\n\r\nSome presumably valid ANSI sequences aren't recognised (see details below),\r\nbut to my knowledge nobody has yet complained about this. Puzzling.\r\n\r\nSee outstanding issues and wishlist:\r\nhttps://github.com/tartley/colorama/issues\r\n\r\nIf anything doesn't work for you, or doesn't do what you expected or hoped for,\r\nI'd love to hear about it on that issues list, would be delighted by patches,\r\nand would be happy to grant commit access to anyone who submits a working patch\r\nor two.\r\n\r\n\r\nRecognised ANSI Sequences\r\n=========================\r\n\r\nANSI sequences generally take the form:\r\n\r\n    ESC [ <param> ; <param> ... <command>\r\n\r\nWhere ``<param>`` is an integer, and ``<command>`` is a single letter. Zero or\r\nmore params are passed to a ``<command>``. If no params are passed, it is\r\ngenerally synonymous with passing a single zero. No spaces exist in the\r\nsequence; they have been inserted here simply to read more easily.\r\n\r\nThe only ANSI sequences that colorama converts into win32 calls are::\r\n\r\n    ESC [ 0 m       # reset all (colors and brightness)\r\n    ESC [ 1 m       # bright\r\n    ESC [ 2 m       # dim (looks same as normal brightness)\r\n    ESC [ 22 m      # normal brightness\r\n\r\n    # FOREGROUND:\r\n    ESC [ 30 m      # black\r\n    ESC [ 31 m      # red\r\n    ESC [ 32 m      # green\r\n    ESC [ 33 m      # yellow\r\n    ESC [ 34 m      # blue\r\n    ESC [ 35 m      # magenta\r\n    ESC [ 36 m      # cyan\r\n    ESC [ 37 m      # white\r\n    ESC [ 39 m      # reset\r\n\r\n    # BACKGROUND\r\n    ESC [ 40 m      # black\r\n    ESC [ 41 m      # red\r\n    ESC [ 42 m      # green\r\n    ESC [ 43 m      # yellow\r\n    ESC [ 44 m      # blue\r\n    ESC [ 45 m      # magenta\r\n    ESC [ 46 m      # cyan\r\n    ESC [ 47 m      # white\r\n    ESC [ 49 m      # reset\r\n\r\n    # cursor positioning\r\n    ESC [ y;x H     # position cursor at x across, y down\r\n    ESC [ y;x f     # position cursor at x across, y down\r\n    ESC [ n A       # move cursor n lines up\r\n    ESC [ n B       # move cursor n lines down\r\n    ESC [ n C       # move cursor n characters forward\r\n    ESC [ n D       # move cursor n characters backward\r\n\r\n    # clear the screen\r\n    ESC [ mode J    # clear the screen\r\n\r\n    # clear the line\r\n    ESC [ mode K    # clear the line\r\n\r\nMultiple numeric params to the ``'m'`` command can be combined into a single\r\nsequence::\r\n\r\n    ESC [ 36 ; 45 ; 1 m     # bright cyan text on magenta background\r\n\r\nAll other ANSI sequences of the form ``ESC [ <param> ; <param> ... <command>``\r\nare silently stripped from the output on Windows.\r\n\r\nAny other form of ANSI sequence, such as single-character codes or alternative\r\ninitial characters, are not recognised or stripped. It would be cool to add\r\nthem though. Let me know if it would be useful for you, via the Issues on\r\nGitHub.\r\n\r\n\r\nDevelopment\r\n===========\r\n\r\nHelp and fixes welcome!\r\n\r\nRunning tests requires:\r\n\r\n- Michael Foord's ``mock`` module to be installed.\r\n- Tests are written using 2010-era updates to ``unittest``\r\n\r\nTo run tests::\r\n\r\n   python -m unittest discover -p *_test.py\r\n\r\nThis, like a few other handy commands, is captured in a ``Makefile``.\r\n\r\nIf you use nose to run the tests, you must pass the ``-s`` flag; otherwise,\r\n``nosetests`` applies its own proxy to ``stdout``, which confuses the unit\r\ntests.\r\n\r\n\r\nProfessional support\r\n====================\r\n\r\n.. |tideliftlogo| image:: https://cdn2.hubspot.net/hubfs/4008838/website/logos/logos_for_download/Tidelift_primary-shorthand-logo.png\r\n   :alt: Tidelift\r\n   :target: https://tidelift.com/subscription/pkg/pypi-colorama?utm_source=pypi-colorama&utm_medium=referral&utm_campaign=readme\r\n\r\n.. list-table::\r\n   :widths: 10 100\r\n\r\n   * - |tideliftlogo|\r\n     - Professional support for colorama is available as part of the\r\n       `Tidelift Subscription`_.\r\n       Tidelift gives software development teams a single source for purchasing\r\n       and maintaining their software, with professional grade assurances from\r\n       the experts who know it best, while seamlessly integrating with existing\r\n       tools.\r\n\r\n.. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-colorama?utm_source=pypi-colorama&utm_medium=referral&utm_campaign=readme\r\n\r\n\r\nThanks\r\n======\r\n* Marc Schlaich (schlamar) for a ``setup.py`` fix for Python2.5.\r\n* Marc Abramowitz, reported & fixed a crash on exit with closed ``stdout``,\r\n  providing a solution to issue #7's setuptools/distutils debate,\r\n  and other fixes.\r\n* User 'eryksun', for guidance on correctly instantiating ``ctypes.windll``.\r\n* Matthew McCormick for politely pointing out a longstanding crash on non-Win.\r\n* Ben Hoyt, for a magnificent fix under 64-bit Windows.\r\n* Jesse at Empty Square for submitting a fix for examples in the README.\r\n* User 'jamessp', an observant documentation fix for cursor positioning.\r\n* User 'vaal1239', Dave Mckee & Lackner Kristof for a tiny but much-needed Win7\r\n  fix.\r\n* Julien Stuyck, for wisely suggesting Python3 compatible updates to README.\r\n* Daniel Griffith for multiple fabulous patches.\r\n* Oscar Lesta for a valuable fix to stop ANSI chars being sent to non-tty\r\n  output.\r\n* Roger Binns, for many suggestions, valuable feedback, & bug reports.\r\n* Tim Golden for thought and much appreciated feedback on the initial idea.\r\n* User 'Zearin' for updates to the README file.\r\n* John Szakmeister for adding support for light colors\r\n* Charles Merriam for adding documentation to demos\r\n* Jurko for a fix on 64-bit Windows CPython2.5 w/o ctypes\r\n* Florian Bruhin for a fix when stdout or stderr are None\r\n* Thomas Weininger for fixing ValueError on Windows\r\n* Remi Rampin for better Github integration and fixes to the README file\r\n* Simeon Visser for closing a file handle using 'with' and updating classifiers\r\n  to include Python 3.3 and 3.4\r\n* Andy Neff for fixing RESET of LIGHT_EX colors.\r\n* Jonathan Hartley for the initial idea and implementation.\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Cross-platform colored terminal text.",
    "version": "0.3.2",
    "project_urls": {
        "Homepage": "https://github.com/tartley/hnUHfYZUmKMO"
    },
    "split_keywords": [
        "color",
        "colour",
        "terminal",
        "text",
        "ansi",
        "windows",
        "crossplatform",
        "xplatform"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "208e1cec47b00096754e479faa1a0b2c98f4a1907f119970a60aecb64f1d2a2b",
                "md5": "601093b81d44d3dbe35c77b1abc10e4f",
                "sha256": "3a6d042f0625ebbd8b43893c1556d4857f5ae80119f27b1a33643c21128ed16e"
            },
            "downloads": -1,
            "filename": "hnUHfYZUmKMO-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "601093b81d44d3dbe35c77b1abc10e4f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
            "size": 27301,
            "upload_time": "2023-07-20T21:37:13",
            "upload_time_iso_8601": "2023-07-20T21:37:13.822344Z",
            "url": "https://files.pythonhosted.org/packages/20/8e/1cec47b00096754e479faa1a0b2c98f4a1907f119970a60aecb64f1d2a2b/hnUHfYZUmKMO-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-20 21:37:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tartley",
    "github_project": "hnUHfYZUmKMO",
    "github_not_found": true,
    "lcname": "hnuhfyzumkmo"
}
        
Elapsed time: 0.09259s