API Reference

Main objects

• WhatsAppChat
  • WhatsAppChat
• FigureBuilder
  • FigureBuilder

Core API

• whatstk.whatsapp
  • whatstk.whatsapp.objects
    • WhatsAppChat
      • WhatsAppChat.df
      • WhatsAppChat.end_date
      • WhatsAppChat.from_source()
      • WhatsAppChat.from_sources()
      • WhatsAppChat.merge()
      • WhatsAppChat.rename_users()
      • WhatsAppChat.start_date
      • WhatsAppChat.to_csv()
      • WhatsAppChat.to_txt()
      • WhatsAppChat.users
  • whatstk.whatsapp.parser
    • df_from_txt_whatsapp()
    • generate_regex()
  • whatstk.whatsapp.auto_header
    • extract_header_from_text()
  • whatstk.whatsapp.generation
    • ChatGenerator
      • ChatGenerator.generate()
    • generate_chats_hformats()
  • whatstk.whatsapp.hformat
    • get_supported_hformats_as_dict()
    • get_supported_hformats_as_list()
    • is_supported()
    • is_supported_verbose()
• whatstk.analysis
  • get_interventions_count()
  • get_response_matrix()
• whatstk.graph
  • whatstk.graph.base
    • FigureBuilder
      • FigureBuilder.user_color_mapping
      • FigureBuilder.user_interventions_count_linechart()
      • FigureBuilder.user_message_responses_flow()
      • FigureBuilder.user_message_responses_heatmap()
      • FigureBuilder.user_msg_length_boxplot()
      • FigureBuilder.usernames
  • whatstk.graph.figures
    • whatstk.graph.figures.boxplot
      • fig_boxplot_msglen()
    • whatstk.graph.figures.heatmap
      • fig_heatmap()
    • whatstk.graph.figures.sankey
      • fig_sankey()
    • whatstk.graph.figures.scatter
      • fig_scatter_time()
    • whatstk.graph.figures.utils
      • hex_color_palette()
• whatstk.utils
  • whatstk.utils.chat_merge
    • merge_chats()
  • whatstk.utils.gdrive
    • gdrive_init()
  • whatstk.utils.exceptions
    • HFormatError
    • RegexError
  • whatstk.utils.utils
    • ColnamesDf
      • ColnamesDf.DATE
      • ColnamesDf.MESSAGE
      • ColnamesDf.MESSAGE_LENGTH
      • ColnamesDf.USERNAME
• whatstk.data
  • Urls
    • Urls.LOREM
    • Urls.LOREM1
    • Urls.LOREM2
    • Urls.LOREM_2000
    • Urls.POKEMON
• whatstk._chat
  • BaseChat
    • BaseChat.df
    • BaseChat.df
    • BaseChat.end_date
    • BaseChat.from_source()
    • BaseChat.merge()
    • BaseChat.rename_users()
    • BaseChat.start_date
    • BaseChat.to_csv()
    • BaseChat.users

Command line tools

• whatst-to-csv
• whatstk-graph
• whatstk-generate-chat