helga
Getting Started
Requirements
Installing
Development Setup
Using Vagrant
Running Tests
Building Docs
Configuring Helga
Custom Settings
Default Configuration
XMPP Configuration
Plugins
Plugin Types
Plugin Priorities
Creating Plugins with Decorators
Handling Unicode
Accessing The Database
Requiring Settings
Communicating Asynchronously
Signals/Notifications of Helga Events
Packaging and Distribution
Installing Plugins
Class-Based Plugins
Supporting XMPP
Webhooks
Overview
The
@route
Decorator
Authenticated Routes
Sending Non-200 Responses
Using Templates
Handling Unicode
Accessing The Database
Requiring Settings
Packaging and Distribution
Installing Webhooks
Builtin Features
Supported Backends
Builtin Plugins
Builtin Webhooks
Channel Logging
API Documentation
helga.comm.irc
helga.comm.xmpp
helga.db
helga.log
helga.plugins
helga.plugins.webhooks
helga.settings
helga.util.encodings
helga
Docs
»
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
A
ACKS (in module helga.plugins)
add_route() (helga.plugins.webhooks.WebhookPlugin method)
(helga.plugins.webhooks.WebhookRoot method)
aliases (helga.plugins.Command attribute)
all_plugins (helga.plugins.Registry attribute)
alterCollidedNick() (helga.comm.irc.Client method)
auth (helga.comm.xmpp.Factory attribute)
authenticated() (in module helga.plugins.webhooks)
AUTO_RECONNECT (in module helga.settings)
AUTO_RECONNECT_DELAY (in module helga.settings)
B
buildProtocol() (helga.comm.irc.Factory method)
C
channel_loggers (helga.comm.irc.Client attribute)
(helga.comm.xmpp.Client attribute)
CHANNEL_LOGGING (in module helga.settings)
CHANNEL_LOGGING_DIR (in module helga.settings)
CHANNEL_LOGGING_HIDE_CHANNELS (in module helga.settings)
ChannelLogFileHandler (class in helga.log)
channels (helga.comm.irc.Client attribute)
(helga.comm.xmpp.Client attribute)
CHANNELS (in module helga.settings)
chat_client (helga.plugins.webhooks.WebhookRoot attribute)
Client (class in helga.comm.irc)
(class in helga.comm.xmpp)
client (helga.comm.xmpp.Factory attribute)
(in module helga.db)
clientConnectionFailed() (helga.comm.irc.Factory method)
(helga.comm.xmpp.Factory method)
clientConnectionLost() (helga.comm.irc.Factory method)
(helga.comm.xmpp.Factory method)
Command (class in helga.plugins)
command (helga.plugins.Command attribute)
command() (in module helga.plugins)
COMMAND_ARGS_SHLEX (in module helga.settings)
COMMAND_PREFIX_BOTNICK (in module helga.settings)
COMMAND_PREFIX_CHAR (in module helga.settings)
compute_next_rollover() (helga.log.ChannelLogFileHandler method)
configure() (in module helga.settings)
connect() (in module helga.db)
control() (helga.plugins.webhooks.WebhookPlugin method)
current_filename() (helga.log.ChannelLogFileHandler method)
D
DATABASE (in module helga.settings)
db (in module helga.db)
decorate() (helga.plugins.Plugin method)
DEFAULT_CHANNEL_PLUGINS (in module helga.settings)
disable() (helga.plugins.Registry method)
DISABLED_PLUGINS (in module helga.settings)
DISABLED_WEBHOOKS (in module helga.settings)
doRollover() (helga.log.ChannelLogFileHandler method)
E
enable() (helga.plugins.Registry method)
enabled_plugins (helga.plugins.Registry attribute)
ENABLED_PLUGINS (in module helga.settings)
ENABLED_WEBHOOKS (in module helga.settings)
encoding (helga.comm.irc.Client attribute)
erroneousNickFallback (helga.comm.irc.Client attribute)
F
Factory (class in helga.comm.irc)
(class in helga.comm.xmpp)
factory (helga.comm.xmpp.Client attribute)
filter() (helga.log.UTCTimeLogFilter method)
format_channel() (helga.comm.xmpp.Client method)
from_unicode() (in module helga.util.encodings)
from_unicode_args() (in module helga.util.encodings)
G
get_channel_logger() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
(in module helga.log)
get_plugin() (helga.plugins.Registry method)
getLogger() (in module helga.log)
H
helga.comm.irc (module)
helga.comm.xmpp (module)
helga.db (module)
helga.log (module)
helga.plugins (module)
helga.plugins.webhooks (module)
helga.settings (module)
helga.util.encodings (module)
help (helga.plugins.Command attribute)
HttpError
I
irc_unknown() (helga.comm.irc.Client method)
is_public_channel() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
J
jid (helga.comm.xmpp.Client attribute)
(helga.comm.xmpp.Factory attribute)
join() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
joined() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
L
last_message (helga.comm.irc.Client attribute)
(helga.comm.xmpp.Client attribute)
leave() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
left() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
lineRate (helga.comm.irc.Client attribute)
list_routes() (helga.plugins.webhooks.WebhookPlugin method)
load() (helga.plugins.Registry method)
log_channel_message() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
LOG_FILE (in module helga.settings)
LOG_FORMAT (in module helga.settings)
LOG_LEVEL (in module helga.settings)
M
Match (class in helga.plugins)
match() (helga.plugins.Match method)
(in module helga.plugins)
me() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
msg() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
N
NICK (in module helga.settings)
nickname (helga.comm.irc.Client attribute)
(helga.comm.xmpp.Client attribute)
O
on_authenticated() (helga.comm.xmpp.Client method)
on_connect() (helga.comm.xmpp.Client method)
on_disconnect() (helga.comm.xmpp.Client method)
on_init_failed() (helga.comm.xmpp.Client method)
on_invite() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
on_message() (helga.comm.xmpp.Client method)
on_nick_collision() (helga.comm.xmpp.Client method)
on_ping() (helga.comm.xmpp.Client method)
on_subscribe() (helga.comm.xmpp.Client method)
on_user_joined() (helga.comm.xmpp.Client method)
on_user_left() (helga.comm.xmpp.Client method)
operators (helga.comm.irc.Client attribute)
(helga.comm.xmpp.Client attribute)
OPERATORS (in module helga.settings)
P
parse() (helga.plugins.Command method)
parse_channel() (helga.comm.xmpp.Client method)
parse_message() (helga.comm.xmpp.Client method)
parse_nick() (helga.comm.irc.Client method)
(helga.comm.xmpp.Client method)
password (helga.comm.irc.Client attribute)
pattern (helga.plugins.Match attribute)
ping() (helga.comm.xmpp.Client method)
Plugin (class in helga.plugins)
PLUGIN_FIRST_RESPONDER_ONLY (in module helga.settings)
PLUGIN_PRIORITY_HIGH (in module helga.settings)
PLUGIN_PRIORITY_LOW (in module helga.settings)
PLUGIN_PRIORITY_NORMAL (in module helga.settings)
plugins (helga.plugins.Registry attribute)
preprocess() (helga.plugins.Plugin method)
(helga.plugins.Registry method)
preprocessor() (in module helga.plugins)
prioritized() (helga.plugins.Registry method)
priority (helga.plugins.Plugin attribute)
PRIORITY_HIGH (in module helga.plugins)
PRIORITY_LOW (in module helga.plugins)
PRIORITY_NORMAL (in module helga.plugins)
privmsg() (helga.comm.irc.Client method)
process() (helga.plugins.Command method)
(helga.plugins.Match method)
(helga.plugins.Plugin method)
(helga.plugins.Registry method)
protocol (helga.comm.xmpp.Factory attribute)
R
random_ack() (in module helga.plugins)
RATE_LIMIT (in module helga.settings)
register() (helga.plugins.Registry method)
Registry (class in helga.plugins)
registry (in module helga.plugins)
reload() (helga.plugins.Registry method)
render() (helga.plugins.webhooks.WebhookRoot method)
ResponseNotReady
route() (in module helga.plugins.webhooks)
routes (helga.plugins.webhooks.WebhookRoot attribute)
run() (helga.plugins.Command method)
(helga.plugins.Match method)
(helga.plugins.Plugin method)
S
SERVER (in module helga.settings)
set_presence() (helga.comm.xmpp.Client method)
shlex (helga.plugins.Command attribute)
shouldRollover() (helga.log.ChannelLogFileHandler method)
signedOn() (helga.comm.irc.Client method)
sourceURL (helga.comm.irc.Client attribute)
stream (helga.comm.xmpp.Client attribute)
T
to_unicode() (in module helga.util.encodings)
to_unicode_args() (in module helga.util.encodings)
U
userJoined() (helga.comm.irc.Client method)
userLeft() (helga.comm.irc.Client method)
username (helga.comm.irc.Client attribute)
UTCTimeLogFilter (class in helga.log)
W
WebhookPlugin (class in helga.plugins.webhooks)
WebhookRoot (class in helga.plugins.webhooks)
WEBHOOKS_CREDENTIALS (in module helga.settings)
WEBHOOKS_PORT (in module helga.settings)
Read the Docs
v: stable
Versions
latest
stable
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.