File: api.rst

package info (click to toggle)
enlighten 1.11.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,480 kB
  • sloc: python: 3,419; makefile: 20
file content (48 lines) | stat: -rw-r--r-- 1,074 bytes parent folder | download
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
..
  Copyright 2017 - 2021 Avram Lubkin, All Rights Reserved

  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.

:github_url: https://github.com/Rockhopper-Technologies/enlighten

API Reference
=============

Classes
-------

.. py:module:: enlighten

.. autoclass:: Manager(stream=None, counter_class=Counter, **kwargs)
   :inherited-members:
   :exclude-members: write, remove

.. autoclass:: NotebookManager(stream=None, counter_class=Counter, **kwargs)
   :inherited-members:
   :exclude-members: write, remove

.. autoclass:: Counter
    :members:
    :inherited-members:
    :exclude-members: elapsed, position

.. autoclass:: StatusBar
    :members:
    :inherited-members:
    :exclude-members: elapsed, position

.. autoclass:: SubCounter
    :members:

Functions
---------

.. autofunction:: enlighten.get_manager(stream=None, counter_class=Counter, **kwargs)


Constants
---------

.. autoclass:: enlighten.Justify