Files
pylib/docs/source/index.rst
2026-01-22 18:50:07 +01:00

58 lines
1.5 KiB
ReStructuredText

.. pylib documentation master file, created by
sphinx-quickstart on Sun May 19 11:04:24 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pylib's documentation!
=================================
.. toctree::
:maxdepth: 6
:caption: Contents:
modules
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
``data_step_std``
-----------------
.. image:: _static/class_diagram.svg
:target: _images/class_diagram.svg
``tui``
-------
``pylib/tui.py`` is the main module for tui 'textual user interface' programs.
* ``curses`` package (for Windows install ``windows-curses``) is the underlying
main package to build terminal programs. The ``curses`` package can also be
used directly.
* Windows (Anaconda):
* ``C:\PathToAnaconda3\condabin\conda.bat activate base``
* ``python -m pip install windows-curses``
* https://github.com/zephyrproject-rtos/windows-curses
* ``drawille`` package is used to draw with braille characters (dottet and
quasi-line charts). Make sure you use a font with Unicode Braille characters.
For Windows e. g.: NSimSun, MS Gothic.
* Install: ``python -m pip install drawille``
* Windows (Anaconda):
* ``C:\PathToAnaconda3\condabin\conda.bat activate base``
* ``python -m pip install drawille``
* ``drawblock`` is used to draw with block characters (histogram).
* ``example/tui.py`` is an example script to build a terminal program.