summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Quast <jquast@io.com>2015-04-14 15:11:47 -0700
committerJeff Quast <jquast@io.com>2015-04-14 15:11:47 -0700
commit91a53689c8d8e612e821c13baf8c9ed9cb923fd4 (patch)
treeefe0c259d7531780bcf8419d3c7bb7aa57d13e2e
parent4dbfce65aed5c29c3bfcff39fb97ced94bbe084a (diff)
downloadblessings-91a53689c8d8e612e821c13baf8c9ed9cb923fd4.tar.gz
Do not use 'ghissue' in README.rst/intro, for pypi
-rw-r--r--docs/intro.rst19
1 files changed, 12 insertions, 7 deletions
diff --git a/docs/intro.rst b/docs/intro.rst
index 6461eae..41b53e5 100644
--- a/docs/intro.rst
+++ b/docs/intro.rst
@@ -20,10 +20,13 @@
.. image:: https://img.shields.io/pypi/dm/blessings.svg
:alt: Downloads
+ :target: https://pypi.python.org/pypi/blessings
Introduction
============
+Blessings is a thin, practical wrapper around terminal capabilities in Python.
+
Coding with *Blessings* looks like this... ::
from blessings import Terminal
@@ -36,8 +39,9 @@ Coding with *Blessings* looks like this... ::
with t.location(0, t.height - 1):
print(t.center(t.blink('press any key to continue.')))
- with t.cbreak():
- t.inkey()
+ with t.keystroke_input():
+ inp = t.keystroke()
+ print('You pressed ' + repr(inp))
The Pitch
@@ -104,17 +108,17 @@ There are decades of legacy tied up in terminal interaction, so attention to
detail and behavior in edge cases make a difference. Here are some ways
*Blessings* has your back:
-* Uses the `terminfo(5)`_ database so it works with any terminal type
+* Uses the `terminfo(5)`_ database so it works with any terminal type.
* Provides up-to-the-moment terminal height and width, so you can respond to
- terminal size changes (*SIGWINCH* signals). (Most other libraries query the
+ terminal size changes (*SIGWINCH* signals): Most other libraries query the
``COLUMNS`` and ``LINES`` environment variables or the ``cols`` or ``lines``
- terminal capabilities, which don't update promptly, if at all.)
+ terminal capabilities, which don't update promptly, if at all.
* Avoids making a mess if the output gets piped to a non-terminal.
* Works great with standard Python string formatting.
* Provides convenient access to **all** terminal capabilities.
* Outputs to any file-like object (*StringIO*, file), not just *stdout*.
* Keeps a minimum of internal state, so you can feel free to mix and match with
- calls to curses or whatever other terminal libraries you like
+ calls to curses or whatever other terminal libraries you like.
* Safely decodes internationalization keyboard input to their unicode equivalents.
* Safely decodes multibyte sequences for application/arrow keys.
* Allows the printable length of strings containing sequences to be determined.
@@ -126,7 +130,8 @@ Blessings does not provide...
* Native color support on the Windows command prompt. A PDCurses_ build
of python for windows provides only partial support at this time -- there
are plans to merge with the ansi_ module in concert with colorama_ to
- resolve this. Patches welcome!
+ resolve this. `Patches welcome
+ <https://github.com/erikrose/blessings/issues/21>`_!
Further Documentation
---------------------