|
1 |
| -.. |img-pyTerminalUI-github| image:: https://img.shields.io/badge/Paebbels-pyTerminalUI-323131.svg?logo=github&longCache=true |
| 1 | +.. |img-TerminalUI-github| image:: https://img.shields.io/badge/pyTooling-pyTooling.TerminalUI-323131.svg?logo=github&longCache=true |
2 | 2 | :alt: Sourcecode on GitHub
|
3 | 3 | :height: 22
|
4 |
| - :target: https://github.com/Paebbels/pyTerminalUI |
5 |
| -.. |img-pyTerminalUI-codelicense| image:: https://img.shields.io/pypi/l/pyTerminalUI?logo=GitHub&label=code%20license |
| 4 | + :target: https://github.com/pyTooling/pyTooling.TerminalUI |
| 5 | +.. |img-TerminalUI-codelicense| image:: https://img.shields.io/pypi/l/pyTooling.TerminalUI?logo=GitHub&label=code%20license |
6 | 6 | :alt: Sourcecode License
|
7 | 7 | :height: 22
|
8 |
| -.. |img-pyTerminalUI-tag| image:: https://img.shields.io/github/v/tag/Paebbels/pyTerminalUI?logo=GitHub&include_prereleases |
| 8 | +.. |img-TerminalUI-tag| image:: https://img.shields.io/github/v/tag/pyTooling/pyTooling.TerminalUI?logo=GitHub&include_prereleases |
9 | 9 | :alt: GitHub tag (latest SemVer incl. pre-release)
|
10 | 10 | :height: 22
|
11 |
| - :target: https://github.com/Paebbels/pyTerminalUI/tags |
12 |
| -.. |img-pyTerminalUI-release| image:: https://img.shields.io/github/v/release/Paebbels/pyTerminalUI?logo=GitHub&include_prereleases |
| 11 | + :target: https://github.com/pyTooling/pyTooling.TerminalUI/tags |
| 12 | +.. |img-TerminalUI-release| image:: https://img.shields.io/github/v/release/pyTooling/pyTooling.TerminalUI?logo=GitHub&include_prereleases |
13 | 13 | :alt: GitHub release (latest SemVer incl. including pre-releases
|
14 | 14 | :height: 22
|
15 |
| - :target: https://github.com/Paebbels/pyTerminalUI/releases/latest |
16 |
| -.. |img-pyTerminalUI-date| image:: https://img.shields.io/github/release-date/Paebbels/pyTerminalUI?logo=GitHub |
| 15 | + :target: https://github.com/pyTooling/pyTooling.TerminalUI/releases/latest |
| 16 | +.. |img-TerminalUI-date| image:: https://img.shields.io/github/release-date/pyTooling/pyTooling.TerminalUI?logo=GitHub |
17 | 17 | :alt: GitHub release date
|
18 | 18 | :height: 22
|
19 |
| - :target: https://github.com/Paebbels/pyTerminalUI/releases |
20 |
| -.. |img-pyTerminalUI-lib-dep| image:: https://img.shields.io/librariesio/dependents/pypi/pyTerminalUI?logo=librariesdotio |
| 19 | + :target: https://github.com/pyTooling/pyTooling.TerminalUI/releases |
| 20 | +.. |img-TerminalUI-lib-dep| image:: https://img.shields.io/librariesio/dependents/pypi/pyTooling.TerminalUI?logo=librariesdotio |
21 | 21 | :alt: Dependents (via libraries.io)
|
22 | 22 | :height: 22
|
23 |
| - :target: https://github.com/Paebbels/pyTerminalUI/network/dependents |
24 |
| -.. |img-pyTerminalUI-gha-pipeline| image:: https://img.shields.io/github/workflow/status/Paebbels/pyTerminalUI/Unit%20Testing,%20Coverage%20Collection,%20Package,%20Release,%20Documentation%20and%20Publish?label=Pipeline&logo=GitHub%20Actions&logoColor=FFFFFF |
| 23 | + :target: https://github.com/pyTooling/pyTooling.TerminalUI/network/dependents |
| 24 | +.. |img-TerminalUI-gha-pipeline| image:: https://img.shields.io/github/workflow/status/pyTooling/pyTooling.TerminalUI/Unit%20Testing,%20Coverage%20Collection,%20Package,%20Release,%20Documentation%20and%20Publish?label=Pipeline&logo=GitHub%20Actions&logoColor=FFFFFF |
25 | 25 | :alt: GitHub Workflow - Build and Test Status
|
26 | 26 | :height: 22
|
27 |
| - :target: https://github.com/Paebbels/pyTerminalUI/actions/workflows/Pipeline.yml |
28 |
| -.. |img-pyTerminalUI-codacy-quality| image:: https://img.shields.io/codacy/grade/e8a1b6e33d564f82927235e17fb26e93?logo=Codacy |
| 27 | + :target: https://github.com/pyTooling/pyTooling.TerminalUI/actions/workflows/Pipeline.yml |
| 28 | +.. |img-TerminalUI-codacy-quality| image:: https://img.shields.io/codacy/grade/e8a1b6e33d564f82927235e17fb26e93?logo=Codacy |
29 | 29 | :alt: Codacy - Quality
|
30 | 30 | :height: 22
|
31 |
| - :target: https://www.codacy.com/manual/Paebbels/pyTerminalUI |
32 |
| -.. |img-pyTerminalUI-codacy-coverage| image:: https://img.shields.io/codacy/coverage/e8a1b6e33d564f82927235e17fb26e93?logo=Codacy |
| 31 | + :target: https://www.codacy.com/manual/pyTooling/pyTooling.TerminalUI |
| 32 | +.. |img-TerminalUI-codacy-coverage| image:: https://img.shields.io/codacy/coverage/e8a1b6e33d564f82927235e17fb26e93?logo=Codacy |
33 | 33 | :alt: Codacy - Line Coverage
|
34 | 34 | :height: 22
|
35 |
| - :target: https://www.codacy.com/manual/Paebbels/pyTerminalUI |
36 |
| -.. |img-pyTerminalUI-codecov-coverage| image:: https://img.shields.io/codecov/c/github/Paebbels/pyTerminalUI?logo=Codecov |
| 35 | + :target: https://www.codacy.com/manual/pyTooling/pyTooling.TerminalUI |
| 36 | +.. |img-TerminalUI-codecov-coverage| image:: https://img.shields.io/codecov/c/github/pyTooling/pyTooling.TerminalUI?logo=Codecov |
37 | 37 | :alt: Codecov - Branch Coverage
|
38 | 38 | :height: 22
|
39 |
| - :target: https://codecov.io/gh/Paebbels/pyTerminalUI |
40 |
| -.. |img-pyTerminalUI-lib-rank| image:: https://img.shields.io/librariesio/sourcerank/pypi/pyTerminalUI?logo=librariesdotio |
| 39 | + :target: https://codecov.io/gh/pyTooling/pyTooling.TerminalUI |
| 40 | +.. |img-TerminalUI-lib-rank| image:: https://img.shields.io/librariesio/sourcerank/pypi/pyTooling.TerminalUI?logo=librariesdotio |
41 | 41 | :alt: Libraries.io SourceRank
|
42 | 42 | :height: 22
|
43 |
| - :target: https://libraries.io/github/Paebbels/pyTerminalUI/sourcerank |
44 |
| -.. |img-pyTerminalUI-pypi-tag| image:: https://img.shields.io/pypi/v/pyTerminalUI?logo=PyPI&logoColor=FBE072 |
| 43 | + :target: https://libraries.io/github/pyTooling/pyTooling.TerminalUI/sourcerank |
| 44 | +.. |img-TerminalUI-pypi-tag| image:: https://img.shields.io/pypi/v/pyTooling.TerminalUI?logo=PyPI&logoColor=FBE072 |
45 | 45 | :alt: PyPI - Tag
|
46 | 46 | :height: 22
|
47 |
| - :target: https://pypi.org/project/pyTerminalUI/ |
48 |
| -.. |img-pyTerminalUI-pypi-python| image:: https://img.shields.io/pypi/pyversions/pyTerminalUI?logo=PyPI&logoColor=FBE072 |
| 47 | + :target: https://pypi.org/project/pyTooling.TerminalUI/ |
| 48 | +.. |img-TerminalUI-pypi-python| image:: https://img.shields.io/pypi/pyversions/pyTooling.TerminalUI?logo=PyPI&logoColor=FBE072 |
49 | 49 | :alt: PyPI - Python Version
|
50 | 50 | :height: 22
|
51 |
| -.. |img-pyTerminalUI-pypi-status| image:: https://img.shields.io/pypi/status/pyTerminalUI?logo=PyPI&logoColor=FBE072 |
| 51 | +.. |img-TerminalUI-pypi-status| image:: https://img.shields.io/pypi/status/pyTooling.TerminalUI?logo=PyPI&logoColor=FBE072 |
52 | 52 | :alt: PyPI - Status
|
53 | 53 | :height: 22
|
54 |
| -.. |img-pyTerminalUI-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyTerminalUI?logo=librariesdotio |
| 54 | +.. |img-TerminalUI-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyTooling.TerminalUI?logo=librariesdotio |
55 | 55 | :alt: Libraries.io status for latest release
|
56 | 56 | :height: 22
|
57 |
| - :target: https://libraries.io/github/Paebbels/pyTerminalUI |
58 |
| -.. |img-pyTerminalUI-req-status| image:: https://img.shields.io/requires/github/Paebbels/pyTerminalUI |
| 57 | + :target: https://libraries.io/github/pyTooling/pyTooling.TerminalUI |
| 58 | +.. |img-TerminalUI-req-status| image:: https://img.shields.io/requires/github/pyTooling/pyTooling.TerminalUI |
59 | 59 | :alt: Requires.io
|
60 | 60 | :height: 22
|
61 |
| - :target: https://requires.io/github/Paebbels/pyTerminalUI/requirements/?branch=master |
62 |
| -.. |img-pyTerminalUI-rtd| image:: https://img.shields.io/readthedocs/pyterminalui?label=ReadTheDocs&logo=readthedocs |
| 61 | + :target: https://requires.io/github/pyTooling/pyTooling.TerminalUI/requirements/?branch=master |
| 62 | +.. |img-TerminalUI-rtd| image:: https://img.shields.io/readthedocs/pyTooling.terminalui?label=ReadTheDocs&logo=readthedocs |
63 | 63 | :alt: Read the Docs
|
64 | 64 | :height: 22
|
65 | 65 | :target: https://pyTerminalUI.readthedocs.io/
|
66 |
| -.. |img-pyTerminalUI-doclicense| image:: https://img.shields.io/badge/doc%20license-CC--BY%204.0-green?logo=readthedocs |
| 66 | +.. |img-TerminalUI-doclicense| image:: https://img.shields.io/badge/doc%20license-CC--BY%204.0-green?logo=readthedocs |
67 | 67 | :alt: Documentation License
|
68 | 68 | :height: 22
|
69 | 69 | :target: LICENSE.md
|
70 |
| -.. |img-pyTerminalUI-doc| image:: https://img.shields.io/badge/doc-read%20now%20%E2%9E%94-blueviolet?logo=readthedocs |
| 70 | +.. |img-TerminalUI-doc| image:: https://img.shields.io/badge/doc-read%20now%20%E2%9E%94-blueviolet?logo=readthedocs |
71 | 71 | :alt: Documentation - Read Now!
|
72 | 72 | :height: 22
|
73 | 73 | :target: https://pyTerminalUI.readthedocs.io/
|
74 | 74 |
|
75 |
| -|img-pyTerminalUI-github| |img-pyTerminalUI-codelicense| |img-pyTerminalUI-tag| |img-pyTerminalUI-release| |img-pyTerminalUI-date| |img-pyTerminalUI-lib-dep| |br| |
76 |
| -|img-pyTerminalUI-gha-pipeline| |img-pyTerminalUI-codacy-quality| |img-pyTerminalUI-codacy-coverage| |img-pyTerminalUI-codecov-coverage| |img-pyTerminalUI-lib-rank| |br| |
77 |
| -|img-pyTerminalUI-pypi-tag| |img-pyTerminalUI-pypi-python| |img-pyTerminalUI-pypi-status| |img-pyTerminalUI-lib-status| |img-pyTerminalUI-req-status| |br| |
78 |
| -|img-pyTerminalUI-rtd| |img-pyTerminalUI-doclicense| |img-pyTerminalUI-doc| |
| 75 | +|img-TerminalUI-github| |img-TerminalUI-codelicense| |img-TerminalUI-tag| |img-TerminalUI-release| |img-TerminalUI-date| |img-TerminalUI-lib-dep| |br| |
| 76 | +|img-TerminalUI-gha-pipeline| |img-TerminalUI-codacy-quality| |img-TerminalUI-codacy-coverage| |img-TerminalUI-codecov-coverage| |img-TerminalUI-lib-rank| |br| |
| 77 | +|img-TerminalUI-pypi-tag| |img-TerminalUI-pypi-python| |img-TerminalUI-pypi-status| |img-TerminalUI-lib-status| |img-TerminalUI-req-status| |br| |
| 78 | +|img-TerminalUI-rtd| |img-TerminalUI-doclicense| |img-TerminalUI-doc| |
79 | 79 |
|
80 | 80 | .. code-block::
|
81 | 81 |
|
|
86 | 86 | | .__/ \__, ||_|\___|_| |_| |_| |_|_|_| |_|\__,_|_|\___/|___|
|
87 | 87 | |_| |___/
|
88 | 88 |
|
89 |
| -pyTerminalUI Documentation |
90 |
| -########################## |
| 89 | +pyTooling.TerminalUI Documentation |
| 90 | +################################## |
91 | 91 |
|
92 | 92 | A set of helpers to implement a text user interface (TUI) in a terminal.
|
93 | 93 |
|
94 | 94 | Introduction
|
95 | 95 | ************
|
96 | 96 |
|
97 |
| -This package offers a :py:class:`pyTerminalUI.LineTerminal` implementation, |
98 |
| -derived from a basic :py:class:`pyTerminalUI.Terminal` class. It eases the |
| 97 | +This package offers a :py:class:`pyTooling.TerminalUI.LineTerminal` implementation, |
| 98 | +derived from a basic :py:class:`pyTooling.TerminalUI.Terminal` class. It eases the |
99 | 99 | creation of simple terminal/console applications. It includes colored outputs
|
100 | 100 | based on
|
101 | 101 |
|
102 | 102 | List of meta classes
|
103 | 103 | ********************
|
104 | 104 |
|
105 |
| -* :py:class:`pyTerminalUI.Terminal` |
106 |
| -* :py:class:`pyTerminalUI.LineTerminal` |
| 105 | +* :py:class:`pyTooling.TerminalUI.Terminal` |
| 106 | +* :py:class:`pyTooling.TerminalUI.LineTerminal` |
107 | 107 |
|
108 | 108 |
|
109 | 109 | Example
|
110 | 110 | *******
|
111 | 111 |
|
112 | 112 | .. code-block:: Python
|
113 | 113 |
|
114 |
| - from pyTerminalUI import LineTerminal |
| 114 | + from pyTooling.TerminalUI import LineTerminal |
115 | 115 |
|
116 | 116 | class Application(LineTerminal):
|
117 | 117 | def __init__(self):
|
@@ -174,7 +174,7 @@ License
|
174 | 174 |
|
175 | 175 |
|
176 | 176 | .. toctree::
|
177 |
| - :caption: pyTerminalUI Classes |
| 177 | + :caption: pyTooling.TerminalUI Classes |
178 | 178 | :hidden:
|
179 | 179 |
|
180 | 180 | Terminal
|
|
0 commit comments