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

Top-level package
-----------------

The main interface for ``cliasi``.

cliasi exports the :class:`~cliasi.Cliasi` instance :data:`~cliasi.cli`
as well as

* :data:`~cliasi.STDOUT_STREAM`
* :data:`~cliasi.STDERR_STREAM`
* :data:`~cliasi.SYMBOLS`
* :class:`~cliasi.constants.TextColor`
* :func:`~cliasi.logging_handler.install_logger` (to install it your own way, is done automatically)

.. autodata:: cliasi.cli
    :annotation: global cli instance
.. py:data:: cliasi.STDOUT_STREAM
    :annotation: <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>

    standard output stream the library uses

.. py:data:: cliasi.STDERR_STREAM
    :annotation: <_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>

    Error stream the library uses

.. py:data:: cliasi.SYMBOLS

    Collection of useful symbols

.. automodule:: cliasi
   :members: Cliasi, TextColor
   :show-inheritance:
   :imported-members:



Constants (Animations)
------------------------

.. automodule:: cliasi.constants
   :members:
   :undoc-members:
   :show-inheritance:


logging handler
--------------------

.. automodule:: cliasi.logging_handler
   :members:
   :undoc-members:
   :show-inheritance: