Export Keybase

ExportKeybase Class

Python3 class to generate lists of information via direct interface to Keybase. Lives in create_export.py.

ExportKeybase Methods

This class contains a list of tools for exporting and transforming various types of information from keybase. So far we can export team chat logs with attachments, and user metadata such as what teams they are on, users they follow, users that follow them and where they have verified their identity such as twitter and facebook.

Prior to running any other method, you must first export a .json file containing the text chat data (provided that no .json file has been exported previously or that you did not copy a .json file from elsewhere). Similarly, any method that interfaces to an SQL database requires conversion from .json to .sqlite prior to running.

Script Setup

from database import Messages, Users
from create_export import ExportKeybase
ex_key = ExportKeybase()
````

## Method List

* [get_teams](../#get_teams)
* [get_team_memberships](../#get_team_memberships)
* [get_user_metadata](../#get_user_metadata)
* [get_team_channels](../#get_team_channels)
* [get_team_chat_channel](../#get_team_chat_channel)
* [get_latest_topic_message](../#get_latest_topic_message)
* [get_latest_message_id](../#get_latest_message_id)
* [get_topic_messages_without_pagination](../#get_topic_messages_without_pagination)
* [get_topic_messages_with_pagination](../#get_topic_messages_with_pagination)
* [get_until_topic_id](../#get_until_topic_id)
* [get_all_topic_messages](../#get_all_topic_messages)
* [export_team_user_metadata_sql](../#export_team_user_metadata_sql)
* [get_root_messages](../#get_root_messages)
* [generate_sql_export](../#generate_sql_export)
* [generate_json_export](../#generate_json_export)
* [export_text_msgs_to_csv](../#export_text_msgs_to_csv)
* [message_table_to_csv](../#message_table_to_csv)
* [export_team_user_metadata_sql](../#export_team_user_metadata_sql)
* [sync_team_topics](../#sync_team_topics)

##### `get_teams` #####

```python
teams = ex_key.get_teams()

Returns string list teams corresponding to each unique team for which the current Keybase user is a member. Must be logged into Keybase.

get_team_memberships

team_members = ex_key.get_team_memberships()

Returns string list teams corresponding to each unique team for which the current Keybase user is a member. Must be logged into Keybase.

get_user_metadata

get_user_metadata = ex_key.get_user_metadata()

Returns dictionary with keys {following: list, followers: list, verification: list, teams: list }

Returns string list user_metadata of URLs where user has verified their Keybase identity plus all teams they are on.

get_team_channels

mah_channels = ex_key.get_team_channels(keybase_team_name)

Returns list of strings mah_channels for each text channel on a team

get_team_chat_channel

obj = ex_key.get_team_chat_channel(keybase_team_name, keybase_topic_name)

Returns obj, a json object of all messages within a Keybase team topic.

get_latest_topic_message

get_latest_message_id

get_topic_messages_without_pagination

get_topic_messages_with_pagination

get_until_topic_id

get_all_topic_messages

export_team_user_metadata_sql

members = ExportKeybase.export_team_user_metadata_sql()

Write a .json file of all users, where they are verified, and what teams they belong to.

get_root_messages

ExportKeybase.get_root_messages(mah_messages, db)

Finds text messages from input message list mah_messages, adds them to the SQL database session db, then commits the session.

generate_sql_export

generate_json_export

ExportKeybase.generate_json_export(keybase_team, output_file)

Creates a .json file named output_file containing all chat messages from an entire team.

• Output .json file is required for all other methods in this class!

export_text_msgs_to_csv

ExportKeybase.export_text_msgs_to_csv(sql_connection_string, output_file)

Export text messages from .sqlite database to .csv spreadsheet specified by output_file.

• Note: requires previous export from .json to .sql.

message_table_to_csv

ExportKeybase.message_table_to_csv(table_object, sql_connection_string, csv_file_name)

Export table object table_object with text message data to .csv spreadsheet.

sync_team_topics

Backlinks

• docs