summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: 41da9220bd1a375c2c213fec49c35602644323f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
=======================
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`_ for a general guide and overview.

However, if you're looking for the documentation of the internal
classes, their methods, and related functions that make up the
internals, you're in the right place.

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

API Documentation
=================

Internal modules are as follows.

terminal module (primary)
-------------------------

.. automodule:: blessings.terminal
   :members:
   :undoc-members:

formatters module
-----------------

.. automodule:: blessings.formatters
   :members:
   :undoc-members:

keyboard module
---------------

.. automodule:: blessings.keyboard
   :members:
   :undoc-members:

sequences module
----------------

.. automodule:: blessings.sequences
   :members:
   :undoc-members: