omnibot
1.0.3-3abc74
Usage
Installation
Quickstart for testing
Docker installation
To run omnibot in Docker
To build the image
pip installation
Make a virtualenv and install pip requirements
Manual installation
Clone omnibot
Make a virtualenv and install pip requirements
Run omnibot
Configuration
Example Minimal Configuration
Basic Configuration
Configuration File Configuration
Teams
Bots
Bot Credential Configuration
URLs Configuration for Use in Slack App Dashboard
SQS Configuration
Redis Configuration
Statsd Configuration
Logging Configuration
Handler Configuration
Common Handler Configuration
Message Handlers
Interactive Component Handlers
Slash Command Handlers
API Access Control Configuration
Adding new slack apps
Adding normal slack apps
Adding a slack app for use as a primary bot
Observability
Stats
Delivery and Processing
Webhook Worker Gevent Pool
Watcher Worker Latency
Logs
Event Subscription Tracing Data
Slash Command Tracing Data
Interactive Component Tracing Data
Development
Quickstart and Development
Prerequisites
Quickstart
Developing new bots
Making and testing changes to omnibot using docker and docker-compose
Omnibot receiver libraries
Python
Event parsing
Event Subscription Events
Message Events
Interactive Component Events
Slash Command Events
Slack proxying
Message handlers
Slash command and interactive component handlers
Writing new callback functions
Contributing
Code of conduct
Contributing code
Sign the Contributor License Agreement (CLA)
File issues in Github
Submit pull requests
Adding new dependencies to requirements
Approving licenses or dependencies
API endpoint
API
API route documentation
Python module documentation
omnibot package
Subpackages
omnibot.authnz package
Submodules
omnibot.authnz.envoy_checks module
Module contents
omnibot.callbacks package
Submodules
omnibot.callbacks.interactive_component_callbacks module
omnibot.callbacks.message_callbacks module
omnibot.callbacks.network_callbacks module
omnibot.callbacks.slash_command_callbacks module
Module contents
omnibot.routes package
Submodules
omnibot.routes.api module
Module contents
omnibot.scripts package
Submodules
omnibot.scripts.omniredis module
omnibot.scripts.utils module
Module contents
omnibot.services package
Subpackages
Submodules
omnibot.services.omniredis module
omnibot.services.sqs module
omnibot.services.stats module
Module contents
omnibot.utils package
Submodules
omnibot.utils.settings module
Module contents
Submodules
omnibot.app module
omnibot.processor module
omnibot.settings module
omnibot.setup_logging module
omnibot.watcher module
omnibot.webhook_worker module
omnibot.wsgi module
Module contents
omnibot
Docs
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
action_ts() (omnibot.services.slack.interactive_component.InteractiveComponent property)
actions() (omnibot.services.slack.interactive_component.InteractiveComponent property)
allowed_paths() (in module omnibot.authnz)
B
bigemoji_callback() (in module omnibot.callbacks.slash_command_callbacks)
bool_env() (in module omnibot.utils.settings)
bootstrap() (in module omnibot.watcher)
Bot (class in omnibot.services.slack.bot)
bot() (omnibot.services.slack.interactive_component.InteractiveComponent property)
(omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
bot_id() (omnibot.services.slack.bot.Bot property)
(omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
BotInitializationError
BotMatcher (class in tests.integration.routes)
C
callback_id() (omnibot.services.slack.interactive_component.InteractiveComponent property)
channel() (omnibot.services.slack.interactive_component.InteractiveComponent property)
(omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
channel_channel_callback() (in module omnibot.callbacks.message_callbacks)
channel_id() (omnibot.services.slack.interactive_component.InteractiveComponent property)
(omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
channel_response_callback() (in module omnibot.callbacks.message_callbacks)
channels() (omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
client() (in module omnibot.services.slack)
(in module tests.integration.conftest)
command() (omnibot.services.slack.slash_command.SlashCommand property)
command_text() (omnibot.services.slack.message.Message property)
component_type() (omnibot.services.slack.interactive_component.InteractiveComponent property)
congratulations_bot_callback() (in module omnibot.callbacks.message_callbacks)
CreateSQSQueue (class in omnibot.scripts.utils)
D
delete_message() (in module omnibot.webhook_worker)
directed() (omnibot.services.slack.message.Message property)
E
echo_callback() (in module omnibot.callbacks.slash_command_callbacks)
echo_dialog_submission_callback() (in module omnibot.callbacks.interactive_component_callbacks)
emails() (omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
enforce_checks() (in module omnibot.authnz)
enterprise_id() (omnibot.services.slack.slash_command.SlashCommand property)
enterprise_name() (omnibot.services.slack.slash_command.SlashCommand property)
envoy_internal_check() (in module omnibot.authnz.envoy_checks)
envoy_permissions_check() (in module omnibot.authnz.envoy_checks)
event_trace() (omnibot.services.slack.interactive_component.InteractiveComponent property)
(omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
example_attachment_callback() (in module omnibot.callbacks.message_callbacks)
example_topic_callback() (in module omnibot.callbacks.message_callbacks)
extract_channels() (in module omnibot.services.slack.parser)
extract_command() (in module omnibot.services.slack.parser)
extract_emails() (in module omnibot.services.slack.parser)
extract_emojis() (in module omnibot.services.slack.parser)
extract_mentions() (in module omnibot.services.slack.parser)
extract_specials() (in module omnibot.services.slack.parser)
extract_subteams() (in module omnibot.services.slack.parser)
extract_urls() (in module omnibot.services.slack.parser)
extract_users() (in module omnibot.services.slack.parser)
F
float_env() (in module omnibot.utils.settings)
G
get() (in module omnibot.settings)
get_bot_by_bot_id() (omnibot.services.slack.bot.Bot class method)
get_bot_by_name() (omnibot.services.slack.bot.Bot class method)
get_bot_by_verification_token() (omnibot.services.slack.bot.Bot class method)
get_bot_ims() (in module omnibot.routes.api)
get_boto_client() (in module omnibot.services)
get_boto_session() (in module omnibot.services)
get_callback_id() (in module omnibot.utils)
get_channel() (in module omnibot.services.slack)
get_channel_by_name() (in module omnibot.routes.api)
(in module omnibot.services.slack)
get_channels() (in module omnibot.services.slack)
get_client() (in module omnibot.services.sqs)
get_emoji() (in module omnibot.services.slack)
get_groups() (in module omnibot.services.slack)
get_im_channel_id() (in module omnibot.services.slack)
get_ims() (in module omnibot.services.slack)
get_mock_data() (in module tests.data)
get_mpims() (in module omnibot.services.slack)
get_name_from_user() (in module omnibot.services.slack)
get_queue_url() (in module omnibot.services.sqs)
get_redis_client (in module omnibot.services.omniredis)
get_statsd_client() (in module omnibot.services.stats)
get_team_by_id() (omnibot.services.slack.team.Team class method)
get_team_by_name() (omnibot.services.slack.team.Team class method)
get_team_id_by_name() (in module omnibot.routes.api)
get_test_bot() (in module tests.integration.routes)
get_user() (in module omnibot.services.slack)
get_user_by_email() (in module omnibot.services.slack)
get_user_by_name() (in module omnibot.services.slack)
get_user_v2() (in module omnibot.routes.api)
get_users() (in module omnibot.services.slack)
H
handle_message() (in module omnibot.webhook_worker)
handle_messages() (in module omnibot.webhook_worker)
healthcheck() (in module omnibot.routes.api)
help_callback() (in module omnibot.callbacks.message_callbacks)
http_callback() (in module omnibot.callbacks.network_callbacks)
I
instrument() (in module tests.integration.conftest)
instrument_event() (in module omnibot.routes.api)
int_env() (in module omnibot.utils.settings)
interactive_component_handlers() (omnibot.services.slack.bot.Bot property)
InteractiveComponent (class in omnibot.services.slack.interactive_component)
internal_client() (in module tests.integration.conftest)
L
logging_context() (omnibot.services.slack.bot.Bot property)
(omnibot.services.slack.team.Team property)
M
main() (in module omnibot.watcher)
(in module omnibot.webhook_worker)
manage (module)
match() (omnibot.services.slack.message.Message property)
match_type() (omnibot.services.slack.message.Message property)
mentioned() (omnibot.services.slack.message.Message property)
merge_logging_context() (in module omnibot.utils)
Message (class in omnibot.services.slack.message)
message() (omnibot.services.slack.interactive_component.InteractiveComponent property)
message_handlers() (omnibot.services.slack.bot.Bot property)
MessageUnsupportedError
N
name() (omnibot.services.slack.bot.Bot property)
(omnibot.services.slack.team.Team property)
O
oauth_bot_token() (omnibot.services.slack.bot.Bot property)
oauth_user_token() (omnibot.services.slack.bot.Bot property)
omnibot (module)
omnibot.app (module)
omnibot.authnz (module)
omnibot.authnz.envoy_checks (module)
omnibot.callbacks (module)
omnibot.callbacks.interactive_component_callbacks (module)
omnibot.callbacks.message_callbacks (module)
omnibot.callbacks.network_callbacks (module)
omnibot.callbacks.slash_command_callbacks (module)
omnibot.processor (module)
omnibot.routes (module)
omnibot.routes.api (module)
omnibot.scripts (module)
omnibot.scripts.omniredis (module)
omnibot.scripts.utils (module)
omnibot.services (module)
omnibot.services.omniredis (module)
omnibot.services.slack (module)
omnibot.services.slack.bot (module)
omnibot.services.slack.interactive_component (module)
omnibot.services.slack.message (module)
omnibot.services.slack.parser (module)
omnibot.services.slack.slash_command (module)
omnibot.services.slack.team (module)
omnibot.services.sqs (module)
omnibot.services.stats (module)
omnibot.settings (module)
omnibot.setup_logging (module)
omnibot.utils (module)
omnibot.utils.settings (module)
omnibot.watcher (module)
omnibot.webhook_worker (module)
omnibot.wsgi (module)
open() (tests.integration.conftest.TestClient method)
(tests.integration.conftest.TestInternalClient method)
P
parse_kwargs() (in module omnibot.processor)
parsed_channel() (omnibot.services.slack.interactive_component.InteractiveComponent property)
parsed_text() (omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
parsed_user() (omnibot.services.slack.interactive_component.InteractiveComponent property)
payload() (omnibot.services.slack.interactive_component.InteractiveComponent property)
(omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
process_event() (in module omnibot.processor)
process_interactive_component() (in module omnibot.processor)
process_slash_command() (in module omnibot.processor)
PurgeRedis (class in omnibot.scripts.omniredis)
Q
queue() (in module tests.integration.conftest)
queue_event() (in module omnibot.routes.api)
R
replace_channels() (in module omnibot.services.slack.parser)
replace_emails() (in module omnibot.services.slack.parser)
replace_specials() (in module omnibot.services.slack.parser)
replace_urls() (in module omnibot.services.slack.parser)
replace_users() (in module omnibot.services.slack.parser)
reset() (tests.conftest.SettingsOverrider method)
response_url() (omnibot.services.slack.interactive_component.InteractiveComponent property)
(omnibot.services.slack.slash_command.SlashCommand property)
run() (omnibot.scripts.omniredis.PurgeRedis method)
(omnibot.scripts.utils.CreateSQSQueue method)
S
send_bot_im() (in module omnibot.routes.api)
set_match() (omnibot.services.slack.message.Message method)
settings_override() (in module tests.conftest)
SettingsOverrider (class in tests.conftest)
slack_action_v2() (in module omnibot.routes.api)
slack_api_call() (in module tests.integration.conftest)
slack_event() (in module omnibot.routes.api)
slack_interactive_component() (in module omnibot.routes.api)
slack_slash_command() (in module omnibot.routes.api)
slash_command_handlers() (omnibot.services.slack.bot.Bot property)
SlashCommand (class in omnibot.services.slack.slash_command)
specials() (omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
specials_callback() (in module omnibot.callbacks.message_callbacks)
str_env() (in module omnibot.utils.settings)
submission() (omnibot.services.slack.interactive_component.InteractiveComponent property)
subtype() (omnibot.services.slack.message.Message property)
T
tableflip_callback() (in module omnibot.callbacks.slash_command_callbacks)
Team (class in omnibot.services.slack.team)
team() (omnibot.services.slack.bot.Bot property)
(omnibot.services.slack.interactive_component.InteractiveComponent property)
(omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
team_id() (omnibot.services.slack.team.Team property)
TeamInitializationError
test_allowed_paths() (in module tests.unit.omnibot.authnz.authnz_test)
test_callback() (in module omnibot.callbacks.message_callbacks)
test_dialog_submission_echo_test() (in module tests.integration.routes.test_interactive)
test_enforce_checks() (in module tests.unit.omnibot.authnz.authnz_test)
test_envoy_internal_check() (in module tests.unit.omnibot.authnz.envoy_checks_test)
test_envoy_permissions_check() (in module tests.unit.omnibot.authnz.envoy_checks_test)
test_event_callback_omnibot_help() (in module tests.integration.routes.test_slack_event)
test_event_callback_test_message() (in module tests.integration.routes.test_slack_event)
test_event_missing_event_block() (in module tests.integration.routes.test_slack_event)
test_extract_mentions() (in module tests.unit.omnibot.services.slack.parser_test)
test_extract_user() (in module tests.unit.omnibot.services.slack.parser_test)
test_get_bot_ims() (in module tests.integration.routes.test_get_ims)
test_get_channel_by_name() (in module tests.integration.routes.test_get_channel)
test_get_channel_by_name_invalid() (in module tests.integration.routes.test_get_channel)
test_get_team_id_by_name() (in module tests.integration.routes.test_get_team)
test_get_team_id_by_name_invalid() (in module tests.integration.routes.test_get_team)
test_get_user_v2_user_found() (in module tests.integration.routes.test_get_user_v2)
test_get_user_v2_user_not_found() (in module tests.integration.routes.test_get_user_v2)
test_handler() (in module tests.data)
test_handlers() (in module tests.unit.omnibot.settings_test)
test_healthcheck() (in module tests.integration.routes.test_healthcheck)
test_interactive_block_component() (in module tests.unit.omnibot.services.slack.interactive_component_test)
test_interactive_component() (in module tests.unit.omnibot.services.slack.interactive_component_test)
test_invalid_bot() (in module tests.integration.routes.test_slack_event)
test_invalid_callback_id() (in module tests.integration.routes.test_interactive)
test_invalid_component_type() (in module tests.integration.routes.test_interactive)
test_invalid_team() (in module tests.integration.routes.test_slack_event)
test_invalid_token() (in module tests.integration.routes.test_interactive)
test_invalid_verification_token() (in module tests.integration.routes.test_slack_event)
(in module tests.integration.routes.test_slash_command)
test_invalid_verification_token_for_valid_bot() (in module tests.integration.routes.test_slack_event)
test_message() (in module tests.unit.omnibot.services.slack.message_test)
test_message_action_on_test_message() (in module tests.integration.routes.test_interactive)
test_misisng_verification_token() (in module tests.integration.routes.test_slack_event)
test_missing_app_id() (in module tests.integration.routes.test_slack_event)
test_missing_handler() (in module tests.integration.routes.test_slash_command)
test_missing_team() (in module tests.integration.routes.test_interactive)
test_missing_team_id() (in module tests.integration.routes.test_slack_event)
(in module tests.integration.routes.test_slash_command)
test_missing_token() (in module tests.integration.routes.test_interactive)
(in module tests.integration.routes.test_slash_command)
test_not_supported_extract() (in module tests.unit.omnibot.services.slack.parser_test)
test_primary_slack_bot() (in module tests.unit.omnibot.settings_test)
test_send_bot_im() (in module tests.integration.routes.test_send_im)
test_slack_action() (in module tests.integration.routes.test_slack_action)
test_slack_bot_tokens() (in module tests.unit.omnibot.settings_test)
test_slack_teams() (in module tests.unit.omnibot.settings_test)
test_team() (in module tests.unit.omnibot.services.slack.bot_test)
(in module tests.unit.omnibot.services.slack.team_test)
test_unsupported_team() (in module tests.integration.routes.test_interactive)
(in module tests.integration.routes.test_slash_command)
test_url_verification() (in module tests.integration.routes.test_slack_event)
test_user_issues_echo_command() (in module tests.integration.routes.test_slash_command)
test_view_submission_synchronous() (in module tests.integration.routes.test_interactive)
TestClient (class in tests.integration.conftest)
TestInternalClient (class in tests.integration.conftest)
tests (module)
tests.conftest (module)
tests.data (module)
tests.integration (module)
tests.integration.conftest (module)
tests.integration.routes (module)
tests.integration.routes.test_get_channel (module)
tests.integration.routes.test_get_ims (module)
tests.integration.routes.test_get_team (module)
tests.integration.routes.test_get_user_v2 (module)
tests.integration.routes.test_healthcheck (module)
tests.integration.routes.test_interactive (module)
tests.integration.routes.test_send_im (module)
tests.integration.routes.test_slack_action (module)
tests.integration.routes.test_slack_event (module)
tests.integration.routes.test_slash_command (module)
tests.unit (module)
tests.unit.omnibot (module)
tests.unit.omnibot.authnz (module)
tests.unit.omnibot.authnz.authnz_test (module)
tests.unit.omnibot.authnz.envoy_checks_test (module)
tests.unit.omnibot.services (module)
tests.unit.omnibot.services.slack (module)
tests.unit.omnibot.services.slack.bot_test (module)
tests.unit.omnibot.services.slack.interactive_component_test (module)
tests.unit.omnibot.services.slack.message_test (module)
tests.unit.omnibot.services.slack.parser_test (module)
tests.unit.omnibot.services.slack.team_test (module)
tests.unit.omnibot.settings_test (module)
text() (omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
thread_ts() (omnibot.services.slack.message.Message property)
trigger_id() (omnibot.services.slack.interactive_component.InteractiveComponent property)
(omnibot.services.slack.slash_command.SlashCommand property)
ts() (omnibot.services.slack.message.Message property)
U
unextract_channels() (in module omnibot.services.slack.parser)
unextract_specials() (in module omnibot.services.slack.parser)
unextract_users() (in module omnibot.services.slack.parser)
unfliptable_callback() (in module omnibot.callbacks.slash_command_callbacks)
update_channel() (in module omnibot.services.slack)
update_conversations() (in module omnibot.services.slack)
update_emoji() (in module omnibot.services.slack)
update_group() (in module omnibot.services.slack)
update_im() (in module omnibot.services.slack)
update_mpim() (in module omnibot.services.slack)
update_user() (in module omnibot.services.slack)
update_users() (in module omnibot.services.slack)
urls() (omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
user() (omnibot.services.slack.interactive_component.InteractiveComponent property)
(omnibot.services.slack.message.Message property)
user_id() (omnibot.services.slack.slash_command.SlashCommand property)
users() (omnibot.services.slack.message.Message property)
(omnibot.services.slack.slash_command.SlashCommand property)
V
verification_token() (omnibot.services.slack.bot.Bot property)
verify_bot() (in module omnibot.routes.api)
W
wait_available() (in module omnibot.webhook_worker)
watch_conversations() (in module omnibot.watcher)
watch_emoji() (in module omnibot.watcher)
watch_users() (in module omnibot.watcher)