summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-09-16 13:46:32 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-09-16 13:47:02 +0000
commit0bf67268edaffea2640c2f05b301a9f857d9e174 (patch)
treec475efbe59347375916de4ff26d690b47c65c9da /README.rst
parentReleasing debian version 2.2.0-4. (diff)
downloadcolorclass-0bf67268edaffea2640c2f05b301a9f857d9e174.tar.xz
colorclass-0bf67268edaffea2640c2f05b301a9f857d9e174.zip
Merging upstream version 2.2.2 (Closes: #1014036).
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst229
1 files changed, 0 insertions, 229 deletions
diff --git a/README.rst b/README.rst
deleted file mode 100644
index b236580..0000000
--- a/README.rst
+++ /dev/null
@@ -1,229 +0,0 @@
-==========
-colorclass
-==========
-
-Yet another ANSI color text library for Python. Provides "auto colors" for dark/light terminals. Works on Linux, OS X,
-and Windows. For Windows support you just need to call ``Windows.enable()`` in your application.
-
-On Linux/OS X ``autocolors`` are toggled by calling ``set_light_background()`` and ``set_dark_background()``. On Windows
-this can be done automatically if you call ``Windows.enable(auto_colors=True)``. Even though the latest Windows 10 does
-support ANSI color codes natively, you still need to run Windows.enable() to take advantage of automatically detecting
-the console's background color.
-
-In Python2.x this library subclasses ``unicode``, while on Python3.x it subclasses ``str``.
-
-* Python 2.6, 2.7, PyPy, PyPy3, 3.3, 3.4, and 3.5 supported on Linux and OS X.
-* Python 2.6, 2.7, 3.3, 3.4, and 3.5 supported on Windows (both 32 and 64 bit versions of Python).
-
-.. image:: https://img.shields.io/appveyor/ci/Robpol86/colorclass/master.svg?style=flat-square&label=AppVeyor%20CI
- :target: https://ci.appveyor.com/project/Robpol86/colorclass
- :alt: Build Status Windows
-
-.. image:: https://img.shields.io/travis/Robpol86/colorclass/master.svg?style=flat-square&label=Travis%20CI
- :target: https://travis-ci.org/Robpol86/colorclass
- :alt: Build Status
-
-.. image:: https://img.shields.io/coveralls/Robpol86/colorclass/master.svg?style=flat-square&label=Coveralls
- :target: https://coveralls.io/github/Robpol86/colorclass
- :alt: Coverage Status
-
-.. image:: https://img.shields.io/pypi/v/colorclass.svg?style=flat-square&label=Latest
- :target: https://pypi.python.org/pypi/colorclass
- :alt: Latest Version
-
-.. image:: https://img.shields.io/pypi/dm/colorclass.svg?style=flat-square&label=PyPI%20Downloads
- :target: https://pypi.python.org/pypi/colorclass
- :alt: Downloads
-
-Quickstart
-==========
-
-Install:
-
-.. code:: bash
-
- pip install colorclass
-
-Piped Command Line
-==================
-
-It is possible to pipe curly-bracket tagged (or regular ANSI coded) text to Python in the command line to produce color
-text. Some examples:
-
-.. code:: bash
-
- echo "{red}Red{/red}" |python -m colorclass # Red colored text.
- echo -e "\033[31mRed\033[0m" | COLOR_DISABLE=true python -m colorclass # Strip colors
- echo -e "\033[31mRed\033[0m" | COLOR_ENABLE=true python -m colorclass &> file.txt # Force colors.
-
-Export these environment variables as "true" to enable/disable some features:
-
-=============== ============================================
-Env Variable Description
-=============== ============================================
-COLOR_ENABLE Force colors even when piping to a file.
-COLOR_DISABLE Strip all colors from incoming text.
-COLOR_LIGHT Use light colored text for dark backgrounds.
-COLOR_DARK Use dark colored text for light backgrounds.
-=============== ============================================
-
-Example Implementation
-======================
-
-.. image:: https://github.com/Robpol86/colorclass/raw/master/example.png?raw=true
- :alt: Example Script Screenshot
-
-.. image:: https://github.com/Robpol86/colorclass/raw/master/example_windows.png?raw=true
- :alt: Example Windows Screenshot
-
-Source code for the example code is: `example.py <https://github.com/Robpol86/colorclass/blob/master/example.py>`_
-
-Usage
-=====
-
-Different colors are chosen using curly-bracket tags, such as ``{red}{/red}``. For a list of available colors, call
-``colorclass.list_tags()``.
-
-The available "auto colors" tags are:
-
-* autoblack
-* autored
-* autogreen
-* autoyellow
-* autoblue
-* automagenta
-* autocyan
-* autowhite
-* autobgblack
-* autobgred
-* autobggreen
-* autobgyellow
-* autobgblue
-* autobgmagenta
-* autobgcyan
-* autobgwhite
-
-Methods of Class instances try to return sane data, such as:
-
-.. code:: python
-
- from colorclass import Color
- color_string = Color('{red}Test{/red}')
-
- color_string
- u'\x1b[31mTest\x1b[39m'
-
- len(color_string)
- 4
-
- color_string.istitle()
- True
-
-There are also a couple of helper attributes for all Color instances:
-
-.. code:: python
-
- color_string.value_colors
- '\x1b[31mTest\x1b[39m'
-
- color_string.value_no_colors
- 'Test'
-
-Changelog
-=========
-
-This project adheres to `Semantic Versioning <http://semver.org/>`_.
-
-2.2.0 - 2016-05-14
-------------------
-
-Added
- * ``disable_if_no_tty()`` function to conditionally disable colors when STDERR and STDOUT are not streams.
-
-Changed
- * Colors enabled by default always, like it was before v2.0.0.
-
-2.1.1 - 2016-05-10
-------------------
-
-Fixed
- * Printing box drawing characters on Windows from Python 2.6.
-
-2.1.0 - 2016-05-07
-------------------
-
-Added
- * ``keep_tags`` boolean keyword argument to Color(). Prevents colorclass from parsing curly brackets.
- * Automatically skip replacing stderr/stdout streams on latest Windows 10 versions with native ANSI color support.
-
-Changed
- * Refactored most of windows.py.
- * Background color determined from either stderr or stdout, instead of just one stream (e.g. piping stderr to file).
-
-Fixed
- * https://github.com/Robpol86/colorclass/issues/16
- * https://github.com/Robpol86/colorclass/issues/18
-
-2.0.0 - 2016-04-10
-------------------
-
-Added
- * Python 3.5 support.
- * ``enable_all_colors()``, ``is_enabled()``, and ``is_light()`` toggle functions.
- * Library can be used as a script (e.g. ``echo "{red}Red{/red}" |python -m colorclass``).
- * Ability to add/multiply Color instances just like str.
- * Ability to iterate a Color instance and have each character keep its color codes.
-
-Changed
- * Converted library from Python module to a package.
- * ``set_light_background()`` and ``set_dark_background()`` no longer enable colors. Use ``enable_all_colors()``.
- * Colors are disabled by default when STDERR and STDOUT are not streams (piped to files/null). Similar to ``grep``.
- * Reduce size of ANSI escape sequences by removing codes that have no effect. e.g. ``\033[31;35m`` to ``\033[35m``.
- * Color methods that return strings now return Color instances instead of str instances.
-
-Fixed
- * https://github.com/Robpol86/colorclass/issues/15
- * https://github.com/Robpol86/colorclass/issues/17
-
-1.2.0 - 2015-03-19
-------------------
-
-Added
- * Convenience single-color methods by `Marc Abramowitz <https://github.com/msabramo>`_.
-
-1.1.2 - 2015-01-07
-------------------
-
-Fixed
- * Maintaining ``Color`` type through ``.encode()`` and ``.decode()`` chains.
-
-1.1.1 - 2014-11-03
-------------------
-
-Fixed
- * Python 2.7 64-bit original colors bug on Windows.
- * resetting colors when ``reset_atexit`` is True.
- * Improved sorting of ``list_tags()``.
-
-1.1.0 - 2014-11-01
-------------------
-
-Added
- * Native Windows support and automatic background colors.
-
-1.0.2 - 2014-10-20
-------------------
-
-Added
- * Ability to disable/strip out all colors.
-
-1.0.1 - 2014-09-11
-------------------
-
-Fixed
- * ``splitlines()`` method.
-
-1.0.0 - 2014-09-01
-------------------
-
-* Initial release.