richcat package

Subpackages

• richcat.modules package
  • Subpackages
    • richcat.modules.consts package
      • Module contents
    • richcat.modules.exceptions package
      • Submodules
      • richcat.modules.exceptions.exception module
      • Module contents
    • richcat.modules.rich_makers package
      • Submodules
      • richcat.modules.rich_makers.markdown_maker module
      • richcat.modules.rich_makers.syntax_maker module
      • richcat.modules.rich_makers.table_maker module
      • richcat.modules.rich_makers.template module
      • Module contents
  • Submodules
  • richcat.modules.help module
  • richcat.modules.utils module
  • Module contents

Submodules

richcat.richcat module

richcat.richcat.check_input_error(args)

The function check input error

Parameters

args (argparse.Namespace) – command line arguments

richcat.richcat.infer_filetype(filepath, filetype)

The function which infer file type

Parameters

• filepath (str) – command line argument of filepath

• filetype (str) – command line argument of filetype

Returns

• filepath (str) – filepath

• filetype (str) – filetype

richcat.richcat.interpret_style(style)

The function interpret style

Parameters

style (str) – command line argument of style

Returns

dic_style – style dict - structure:

• ’header’: True/False

• ’pager’: True/False

Return type

dict

richcat.richcat.main()

richcat.richcat.print_rich(filetype, target_width, color_system, style, filepath=None, file_contents=None)

The function which make rich text

Parameters

• filepath (str) – filepath

• filetype (str) – filetype

• target_width (float) – target_width

• color_system (str) – color system

• style (str) – command line argument of style

richcat.richcat.richcat(args)

Module contents

richcat.richcat(filepath=None, file_contents=None, **args)

The richcat function called from Python script

Parameters

• filepath (str) – filepath

• **args (args) – filetype : str width : int or float color_system : str style : str

• Returns – None

• ------- –