Index

A

addon() (in module matrixctl.commands.adduser.addon) (in module matrixctl.commands.check.addon) (in module matrixctl.commands.delete_local_media.addon) (in module matrixctl.commands.delroom.addon) (in module matrixctl.commands.deluser.addon) (in module matrixctl.commands.deploy.addon) (in module matrixctl.commands.download.addon) (in module matrixctl.commands.get_event.addon) (in module matrixctl.commands.get_event_context.addon) (in module matrixctl.commands.get_events.addon) (in module matrixctl.commands.is_admin.addon) (in module matrixctl.commands.joinroom.addon) (in module matrixctl.commands.largest_rooms.addon) (in module matrixctl.commands.maintenance.addon) (in module matrixctl.commands.make_room_admin.addon) (in module matrixctl.commands.purge_history.addon) (in module matrixctl.commands.purge_remote_media.addon) (in module matrixctl.commands.report.addon) (in module matrixctl.commands.reports.addon) (in module matrixctl.commands.rooms.addon) (in module matrixctl.commands.server_notice.addon) (in module matrixctl.commands.set_admin.addon) (in module matrixctl.commands.start.addon) (in module matrixctl.commands.stop.addon) (in module matrixctl.commands.update.addon) (in module matrixctl.commands.upload.addon) (in module matrixctl.commands.user.addon) (in module matrixctl.commands.users.addon)

address (matrixctl.handlers.ssh.SSH attribute) (matrixctl.structures.ConfigServerSSH attribute) ansible (matrixctl.structures.ConfigServer attribute) ansible_run() (in module matrixctl.handlers.ansible) api (matrixctl.structures.ConfigServer attribute) apply_defaults() (matrixctl.handlers.yaml.YAML static method) ask_password() (in module matrixctl.password_helpers) ask_question() (in module matrixctl.password_helpers) async_worker() (in module matrixctl.handlers.api)

B

BUGMSG (matrixctl.errors.Error attribute)

C

cells_to_str() (in module matrixctl.handlers.table) check_point_in_time() (in module matrixctl.commands.purge_history.timing) COMPRESS_STATE (matrixctl.commands.maintenance.addon.Task attribute) concurrent_limit (matrixctl.handlers.api.RequestBuilder attribute) (matrixctl.handlers.api.RequestStrategy attribute) (matrixctl.structures.ConfigServerAPI attribute) Config (class in matrixctl.structures) ConfigFileError

ConfigServer (class in matrixctl.structures) ConfigServerAnsible (class in matrixctl.structures) ConfigServerAPI (class in matrixctl.structures) ConfigServerMaintenance (class in matrixctl.structures) ConfigServerSSH (class in matrixctl.structures) ConfigServerSynapse (class in matrixctl.structures) content (matrixctl.handlers.api.RequestBuilder attribute) create_user() (in module matrixctl.password_helpers)

D

data (matrixctl.handlers.api.RequestBuilder attribute) database (matrixctl.handlers.db.DBConnectionBuilder attribute) datetime_last_pulled_commit (matrixctl.handlers.vcs.VCS property) db_connect() (in module matrixctl.handlers.db)

DBConnectionBuilder (class in matrixctl.handlers.db) DEFAULT_PATHS (matrixctl.handlers.yaml.YAML attribute) dialog_input() (in module matrixctl.commands.purge_history.dialog) domain (matrixctl.handlers.api.RequestBuilder attribute) (matrixctl.structures.ConfigServerAPI attribute)

E

Error

exec_async_request() (in module matrixctl.handlers.api)

F

filter_empty_rooms() (in module matrixctl.commands.rooms.addon) find_newlines() (in module matrixctl.handlers.table)

format_bytes() (in module matrixctl.commands.largest_rooms.to_table) format_table_row() (in module matrixctl.handlers.table)

G

generate_output() (in module matrixctl.commands.largest_rooms.addon) (in module matrixctl.commands.rooms.addon) generate_user_tables() (in module matrixctl.commands.user.to_table) generate_worker_configs() (in module matrixctl.handlers.api) get() (matrixctl.handlers.yaml.YAML method)

get_colum_length() (in module matrixctl.handlers.table) get_paths_to_config() (matrixctl.handlers.yaml.YAML static method) get_server_config() (matrixctl.handlers.yaml.YAML method) get_version() (in module matrixctl.package_version) group_async_results() (in module matrixctl.handlers.api)

H

handle_arguments() (in module matrixctl.commands.delroom.addon) handle_newlines() (in module matrixctl.handlers.table) handle_purge_status() (in module matrixctl.commands.purge_history.handler) handle_status() (in module matrixctl.commands.delroom.addon) handle_sync_response_status_code() (in module matrixctl.handlers.api)

handle_timestamp() (in module matrixctl.commands.delete_local_media.addon) (in module matrixctl.commands.purge_remote_media.addon) headers (matrixctl.handlers.api.RequestBuilder attribute) headers_with_auth (matrixctl.handlers.api.RequestBuilder property) host (matrixctl.handlers.db.DBConnectionBuilder attribute) human_readable_bool() (in module matrixctl.print_helpers)

I

import_commands_from() (in module matrixctl.addon_manager)

InternalResponseError iterations (matrixctl.handlers.api.RequestStrategy attribute)

J

JINJA_PREDEFINED (matrixctl.handlers.yaml.YAML attribute)

JinjaUndefined (class in matrixctl.handlers.yaml) json (matrixctl.handlers.api.RequestBuilder attribute)

L

limit (matrixctl.handlers.api.RequestStrategy attribute)

log() (matrixctl.handlers.vcs.VCS method)

M

M_ROOM_AVATAR (matrixctl.sanitizers.MessageType attribute) M_ROOM_CREATE (matrixctl.sanitizers.MessageType attribute) M_ROOM_JOIN_RULES (matrixctl.sanitizers.MessageType attribute) M_ROOM_MEMBER (matrixctl.sanitizers.MessageType attribute) M_ROOM_MESSAGE (matrixctl.sanitizers.MessageType attribute) M_ROOM_NAME (matrixctl.sanitizers.MessageType attribute) M_ROOM_PINNED_EVENTS (matrixctl.sanitizers.MessageType attribute) M_ROOM_POWER_LEVELS (matrixctl.sanitizers.MessageType attribute) M_ROOM_REDACTION (matrixctl.sanitizers.MessageType attribute) M_ROOM_TOPIC (matrixctl.sanitizers.MessageType attribute) maintenance (matrixctl.structures.ConfigServer attribute) make_human_readable() (in module matrixctl.commands.user.to_table) matrixctl module matrixctl.addon_manager module matrixctl.commands.adduser.addon module matrixctl.commands.adduser.parser module matrixctl.commands.check.addon module matrixctl.commands.check.parser module matrixctl.commands.delete_local_media.addon module matrixctl.commands.delete_local_media.parser module matrixctl.commands.delroom.addon module matrixctl.commands.delroom.parser module matrixctl.commands.deluser.addon module matrixctl.commands.deluser.parser module matrixctl.commands.deploy.addon module matrixctl.commands.deploy.parser module matrixctl.commands.download.addon module matrixctl.commands.download.parser module matrixctl.commands.get_event.addon module matrixctl.commands.get_event.parser module matrixctl.commands.get_event_context.addon module matrixctl.commands.get_event_context.parser module matrixctl.commands.get_events.addon module matrixctl.commands.get_events.parser module matrixctl.commands.is_admin.addon module matrixctl.commands.is_admin.parser module matrixctl.commands.joinroom.addon module matrixctl.commands.joinroom.parser module matrixctl.commands.largest_rooms.addon module matrixctl.commands.largest_rooms.parser module matrixctl.commands.largest_rooms.to_table module matrixctl.commands.maintenance.addon module matrixctl.commands.maintenance.parser module matrixctl.commands.make_room_admin.addon module matrixctl.commands.make_room_admin.parser module matrixctl.commands.purge_history.addon module matrixctl.commands.purge_history.dialog module matrixctl.commands.purge_history.handler module matrixctl.commands.purge_history.parser module matrixctl.commands.purge_history.timing module matrixctl.commands.purge_remote_media.addon module matrixctl.commands.purge_remote_media.parser module matrixctl.commands.report.addon module matrixctl.commands.report.parser module matrixctl.commands.reports.addon module matrixctl.commands.reports.parser module matrixctl.commands.reports.to_table module matrixctl.commands.rooms.addon module matrixctl.commands.rooms.parser module matrixctl.commands.rooms.to_table module matrixctl.commands.server_notice.addon module matrixctl.commands.server_notice.parser module matrixctl.commands.set_admin.addon module matrixctl.commands.set_admin.parser module matrixctl.commands.start.addon module matrixctl.commands.start.parser module matrixctl.commands.stop.addon module matrixctl.commands.stop.parser module matrixctl.commands.update.addon module matrixctl.commands.update.parser module matrixctl.commands.upload.addon module

matrixctl.commands.upload.parser module matrixctl.commands.user.addon module matrixctl.commands.user.parser module matrixctl.commands.user.to_table module matrixctl.commands.users.addon module matrixctl.commands.users.parser module matrixctl.commands.users.to_table module matrixctl.errors module matrixctl.handlers.ansible module matrixctl.handlers.api module matrixctl.handlers.db module matrixctl.handlers.ssh module matrixctl.handlers.table module matrixctl.handlers.vcs module matrixctl.handlers.yaml module matrixctl.package_version module matrixctl.password_helpers module matrixctl.print_helpers module matrixctl.sanitizers module matrixctl.structures module matrixctl.typehints module MessageType (class in matrixctl.sanitizers) method (matrixctl.handlers.api.RequestBuilder attribute) module matrixctl matrixctl.addon_manager matrixctl.commands.adduser.addon matrixctl.commands.adduser.parser matrixctl.commands.check.addon matrixctl.commands.check.parser matrixctl.commands.delete_local_media.addon matrixctl.commands.delete_local_media.parser matrixctl.commands.delroom.addon matrixctl.commands.delroom.parser matrixctl.commands.deluser.addon matrixctl.commands.deluser.parser matrixctl.commands.deploy.addon matrixctl.commands.deploy.parser matrixctl.commands.download.addon matrixctl.commands.download.parser matrixctl.commands.get_event.addon matrixctl.commands.get_event.parser matrixctl.commands.get_event_context.addon matrixctl.commands.get_event_context.parser matrixctl.commands.get_events.addon matrixctl.commands.get_events.parser matrixctl.commands.is_admin.addon matrixctl.commands.is_admin.parser matrixctl.commands.joinroom.addon matrixctl.commands.joinroom.parser matrixctl.commands.largest_rooms.addon matrixctl.commands.largest_rooms.parser matrixctl.commands.largest_rooms.to_table matrixctl.commands.maintenance.addon matrixctl.commands.maintenance.parser matrixctl.commands.make_room_admin.addon matrixctl.commands.make_room_admin.parser matrixctl.commands.purge_history.addon matrixctl.commands.purge_history.dialog matrixctl.commands.purge_history.handler matrixctl.commands.purge_history.parser matrixctl.commands.purge_history.timing matrixctl.commands.purge_remote_media.addon matrixctl.commands.purge_remote_media.parser matrixctl.commands.report.addon matrixctl.commands.report.parser matrixctl.commands.reports.addon matrixctl.commands.reports.parser matrixctl.commands.reports.to_table matrixctl.commands.rooms.addon matrixctl.commands.rooms.parser matrixctl.commands.rooms.to_table matrixctl.commands.server_notice.addon matrixctl.commands.server_notice.parser matrixctl.commands.set_admin.addon matrixctl.commands.set_admin.parser matrixctl.commands.start.addon matrixctl.commands.start.parser matrixctl.commands.stop.addon matrixctl.commands.stop.parser matrixctl.commands.update.addon matrixctl.commands.update.parser matrixctl.commands.upload.addon matrixctl.commands.upload.parser matrixctl.commands.user.addon matrixctl.commands.user.parser matrixctl.commands.user.to_table matrixctl.commands.users.addon matrixctl.commands.users.parser matrixctl.commands.users.to_table matrixctl.errors matrixctl.handlers.ansible matrixctl.handlers.api matrixctl.handlers.db matrixctl.handlers.ssh matrixctl.handlers.table matrixctl.handlers.vcs matrixctl.handlers.yaml matrixctl.package_version matrixctl.password_helpers matrixctl.print_helpers matrixctl.sanitizers matrixctl.structures matrixctl.typehints tests.matrixctl.handlers.conftest tests.matrixctl.handlers.test_yaml tests.matrixctl.test_sanitizers

N

newlines_in_row() (in module matrixctl.handlers.table)

O

offset (matrixctl.handlers.api.RequestStrategy attribute)

P

params (matrixctl.handlers.api.RequestBuilder attribute) password (matrixctl.handlers.db.DBConnectionBuilder attribute) path (matrixctl.handlers.api.RequestBuilder attribute) playbook (matrixctl.structures.ConfigServerAnsible attribute) (matrixctl.structures.ConfigServerSynapse attribute)

port (matrixctl.handlers.db.DBConnectionBuilder attribute) (matrixctl.handlers.ssh.SSH attribute) (matrixctl.structures.ConfigServerSSH attribute) preplan_request_strategy() (in module matrixctl.handlers.api) print_tasks() (in module matrixctl.commands.maintenance.addon) pull() (matrixctl.handlers.vcs.VCS method)

Q

QWorkerExit

R

read_from_file() (matrixctl.handlers.yaml.YAML static method) request() (in module matrixctl.handlers.api)

RequestBuilder (class in matrixctl.handlers.api) RequestStrategy (class in matrixctl.handlers.api) run_cmd() (matrixctl.handlers.ssh.SSH method)

S

sanitize() (in module matrixctl.sanitizers) sanitize_event_identifier() (in module matrixctl.sanitizers) sanitize_message_type() (in module matrixctl.sanitizers) sanitize_room_identifier() (in module matrixctl.sanitizers) sanitize_user_identifier() (in module matrixctl.sanitizers) scheme (matrixctl.handlers.api.RequestBuilder attribute) (matrixctl.handlers.db.DBConnectionBuilder attribute) secrets_filter() (in module matrixctl.handlers.yaml) server (matrixctl.handlers.yaml.YAML attribute) (matrixctl.structures.Config attribute) servers (matrixctl.structures.Config attribute) setup() (in module matrixctl.addon_manager) SSH (class in matrixctl.handlers.ssh) ssh (matrixctl.structures.ConfigServer attribute) ssh_tunnel() (in module matrixctl.handlers.db) SSHResponse (class in matrixctl.handlers.ssh) stderr (matrixctl.handlers.ssh.SSHResponse attribute) stdin (matrixctl.handlers.ssh.SSHResponse attribute) stdout (matrixctl.handlers.ssh.SSHResponse attribute) step_size (matrixctl.handlers.api.RequestStrategy attribute) streamed_download() (in module matrixctl.handlers.api) subdomain (matrixctl.handlers.api.RequestBuilder attribute) subparser() (in module matrixctl.addon_manager) subparser_adduser() (in module matrixctl.commands.adduser.parser) subparser_check() (in module matrixctl.commands.check.parser) subparser_delete_local_media() (in module matrixctl.commands.delete_local_media.parser) subparser_delroom() (in module matrixctl.commands.delroom.parser)

subparser_deluser() (in module matrixctl.commands.deluser.parser) (in module matrixctl.commands.joinroom.parser) subparser_deploy() (in module matrixctl.commands.deploy.parser) subparser_download() (in module matrixctl.commands.download.parser) subparser_get_event() (in module matrixctl.commands.get_event.parser) subparser_get_event_context() (in module matrixctl.commands.get_event_context.parser) subparser_get_events() (in module matrixctl.commands.get_events.parser) subparser_is_admin() (in module matrixctl.commands.is_admin.parser) subparser_maintenance() (in module matrixctl.commands.maintenance.parser) subparser_make_room_admin() (in module matrixctl.commands.make_room_admin.parser) subparser_purge_history() (in module matrixctl.commands.purge_history.parser) subparser_purge_remote_media() (in module matrixctl.commands.purge_remote_media.parser) subparser_report() (in module matrixctl.commands.report.parser) subparser_reports() (in module matrixctl.commands.reports.parser) subparser_restart() (in module matrixctl.commands.start.parser) subparser_rooms() (in module matrixctl.commands.largest_rooms.parser) (in module matrixctl.commands.rooms.parser) subparser_server_notice() (in module matrixctl.commands.server_notice.parser) subparser_set_admin() (in module matrixctl.commands.set_admin.parser) subparser_start() (in module matrixctl.commands.start.parser) subparser_stop() (in module matrixctl.commands.stop.parser) subparser_update() (in module matrixctl.commands.update.parser) subparser_upload() (in module matrixctl.commands.upload.parser) subparser_user() (in module matrixctl.commands.user.parser) subparser_users() (in module matrixctl.commands.users.parser) success_codes (matrixctl.handlers.api.RequestBuilder attribute) synapse (matrixctl.structures.ConfigServer attribute)

T

table() (in module matrixctl.handlers.table) Task (class in matrixctl.commands.maintenance.addon) tasks (matrixctl.structures.ConfigServerMaintenance attribute) test_get_ansible_playbook() (in module tests.matrixctl.handlers.test_yaml) test_get_api_domain() (in module tests.matrixctl.handlers.test_yaml) test_get_api_token() (in module tests.matrixctl.handlers.test_yaml) test_get_api_username() (in module tests.matrixctl.handlers.test_yaml) test_get_ssh_address() (in module tests.matrixctl.handlers.test_yaml) test_get_ssh_port() (in module tests.matrixctl.handlers.test_yaml) test_get_ssh_user() (in module tests.matrixctl.handlers.test_yaml) test_get_synapse_playbook() (in module tests.matrixctl.handlers.test_yaml) test_repr() (in module tests.matrixctl.handlers.test_yaml) test_sanitize_event_identifier_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_event_identifier_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_event_identifier_3() (in module tests.matrixctl.test_sanitizers) test_sanitize_event_identifier_4() (in module tests.matrixctl.test_sanitizers) test_sanitize_event_identifier_5() (in module tests.matrixctl.test_sanitizers) test_sanitize_event_identifier_6() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_invalid() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_lower_case() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_avatar_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_avatar_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_create_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_create_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_join_rules_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_join_rules_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_member_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_member_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_message_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_message_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_name_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_name_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_pinned_events_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_pinned_events_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_power_levels_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_power_levels_2() (in module tests.matrixctl.test_sanitizers)

test_sanitize_message_type_m_room_redaction_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_redaction_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_topic_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_m_room_topic_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_none() (in module tests.matrixctl.test_sanitizers) test_sanitize_message_type_with_spaces() (in module tests.matrixctl.test_sanitizers) test_sanitize_room_identifier_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_room_identifier_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_room_identifier_3() (in module tests.matrixctl.test_sanitizers) test_sanitize_room_identifier_4() (in module tests.matrixctl.test_sanitizers) test_sanitize_room_identifier_5() (in module tests.matrixctl.test_sanitizers) test_sanitize_room_identifier_6() (in module tests.matrixctl.test_sanitizers) test_sanitize_user_identifier_1() (in module tests.matrixctl.test_sanitizers) test_sanitize_user_identifier_2() (in module tests.matrixctl.test_sanitizers) test_sanitize_user_identifier_3() (in module tests.matrixctl.test_sanitizers) test_sanitize_user_identifier_4() (in module tests.matrixctl.test_sanitizers) test_sanitize_user_identifier_5() (in module tests.matrixctl.test_sanitizers) test_sanitize_user_identifier_6() (in module tests.matrixctl.test_sanitizers) test_str() (in module tests.matrixctl.handlers.test_yaml) tests.matrixctl.handlers.conftest module tests.matrixctl.handlers.test_yaml module tests.matrixctl.test_sanitizers module timeout (matrixctl.handlers.api.RequestBuilder attribute) (matrixctl.handlers.db.DBConnectionBuilder attribute) timestamp_to_dt() (in module matrixctl.print_helpers) to_table() (in module matrixctl.commands.largest_rooms.to_table) (in module matrixctl.commands.reports.to_table) (in module matrixctl.commands.rooms.to_table) (in module matrixctl.commands.user.to_table) (in module matrixctl.commands.users.to_table) token (matrixctl.handlers.api.RequestBuilder attribute) (matrixctl.structures.ConfigServerAPI attribute) transpose_newlines_to_rows() (in module matrixctl.handlers.table) tree_printer() (in module matrixctl.handlers.yaml)

U

user (matrixctl.handlers.ssh.SSH attribute) (matrixctl.structures.ConfigServerSSH attribute)

username (matrixctl.handlers.db.DBConnectionBuilder attribute) (matrixctl.structures.ConfigServerAPI attribute)

V

VACUUM (matrixctl.commands.maintenance.addon.Task attribute)

VCS (class in matrixctl.handlers.vcs)

Y

YAML (class in matrixctl.handlers.yaml)

yaml() (in module tests.matrixctl.handlers.conftest)