stenotype package

Subpackages

• stenotype.backend package
  • Submodules
  • stenotype.backend.elements module
  • stenotype.backend.grammar module
  • stenotype.backend.steno module
  • stenotype.backend.typing module

Submodules

stenotype.cli module

Command Line Interface for stenotype.

The backend is exposed here through a simple command line interface. Documentation of their usage is contained in the docstrings, which are written in a way that they will be rendered nicely by click’s automatic –help text generator.

stenotype.util module

Utility functions and constants for stenotype.

Functions and constants that are general purpose and do not belong to any module in particular should be collected here.

When adding code to this file, please take note that it should always be importable from any point in the project in order to retain its global status. As a consequence, it can’t import anything from the project itself (e.g. “import stenotypes.something”), since that would lead to circular dependencies down the line. Code that is needed here should always have been here from the start.

exception stenotype.util.StenotypeException

Bases: Exception

stenotype.util.setup_logging(loglevel: str)

Set up basic logging to stdout.

Parameters

loglevel – Can be any of [DEBUG, INFO, WARNING, ERROR, CRITICAL]