summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: 63ee5be921bc5758ecca3d938f4887cf92053889 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
=======================
Blessings API Reference
=======================

Read The Readme First
=====================

This is the API documentation for the Blessings terminal library. Because
Blessings uses quite a bit of dynamism, you should `read the readme first`_, as
not all the useful stuff shows up in these autogenerated docs. However, if
you're looking for seldom-used keyword args or a peek at the internals, you're
in the right place.

.. _`read the readme first`: http://pypi.python.org/pypi/blessings/

Then Read This If You Want
==========================

.. autoclass:: blessings.Terminal
    :members: __init__, __getattr__, location, height, width, color, on_color, number_of_colors, fullscreen, hidden_cursor