summaryrefslogtreecommitdiffstats
path: root/external_libs/python/termstyle/README.rst
diff options
context:
space:
mode:
authorDan Klein <danklei@cisco.com>2015-08-26 18:16:09 +0300
committerDan Klein <danklei@cisco.com>2015-08-26 18:16:09 +0300
commitf8ac9d14a989c8cf1535e16165551dfa370b0b74 (patch)
tree43e396eb5d096ad74ec02afeccf8995a4d241a0f /external_libs/python/termstyle/README.rst
parentcdcc62972d42f009f55e6aeb2ca5c60c3acd75eb (diff)
parent53f0e28d7f30c7175cbb15884c309613593859d8 (diff)
Merge branch 'master' into dan_stateless
Diffstat (limited to 'external_libs/python/termstyle/README.rst')
-rw-r--r--external_libs/python/termstyle/README.rst82
1 files changed, 0 insertions, 82 deletions
diff --git a/external_libs/python/termstyle/README.rst b/external_libs/python/termstyle/README.rst
deleted file mode 100644
index f3dfa0ab..00000000
--- a/external_libs/python/termstyle/README.rst
+++ /dev/null
@@ -1,82 +0,0 @@
-=========
-termstyle
-=========
-
-termstyle is a simple python library for adding coloured output to
-terminal (console) programs. The definitions come from ECMA-048_, the
-"Control Functions for Coded Character Sets" standard.
-
-Installation:
--------------
-
-I thoroughly recommend using the zero-install feed (see the project homepage) to manage your dependencies if at all possible. zero-install_ provides a much better system than pip or easy_install, and works with absolutely any language and allows decentralised package management that requires no special privileges to install.
-
-Example Usage:
---------------
-::
-
- from termstyle import *
- print "%s:%s" % (red('Hey'), green('how are you?'))
- print blue('How ', bold('you'), ' doin?')
-
-or, you can use a colour just as a string::
-
- print "%sBlue!%s" % (blue, reset)
-
-Styles:
--------
-::
-
- reset or default (no colour / style)
-
-colour::
-
- black
- red
- green
- yellow
- blue
- magenta
- cyan
- white
-
-background colour::
-
- bg_black
- bg_red
- bg_green
- bg_yellow
- bg_blue
- bg_magenta
- bg_cyan
- bg_white
- bg_default
-
-In terminals supporting transparency ``bg_default`` is often used to set
-the background to transparent [#]_.
-
-weight::
-
- bold
- inverted
-
-style::
-
- italic
- underscore
-
-Controls:
----------
-::
-
- auto() - sets colouring on only if sys.stdout is a terminal
- disabe() - disable colours
- enable() - enable colours
-
-.. [#] Supporting terminals include rxvt-unicode_, and Eterm_.
-
-.. _ECMA-048: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf
-.. _rxvt-unicode: http://software.schmorp.de/
-.. _Eterm: http://www.eterm.org/
-.. _zero-install: http://0install.net/
-