skrobot.notification package

Submodules

skrobot.notification.base_notifier module

class skrobot.notification.base_notifier.BaseNotifier[source]

Bases: abc.ABC

The BaseNotifier is an abstract base class for implementing notifiers.

A notifier can be used to send notifications.

abstract notify(message)[source]

An abstract method for sending the notification.

Parameters

message (str) – The notification’s message.

skrobot.notification.email_notifier module

class skrobot.notification.email_notifier.EmailNotifier(email_subject, sender_account, sender_password, smtp_server, smtp_port, recipients)[source]

Bases: skrobot.notification.base_notifier.BaseNotifier

The EmailNotifier class can be used to send email notifications.

__init__(email_subject, sender_account, sender_password, smtp_server, smtp_port, recipients)[source]

This is the constructor method and can be used to create a new object instance of EmailNotifier class.

Parameters

  • email_subject (str) – The subject of the email.

  • sender_account (str) – The email account of the sender. For example, ‘someone@gmail.com’.

  • sender_password (str) – The password of the sender email account.

  • smtp_server (str) – The secured SMTP server of the sender email account. For example, for Gmail is ‘smtp.gmail.com’.

  • smtp_port (int) – The port of the secured SMTP server. For example, for Gmail is 465.

  • recipients (str) – The recipients (email addresses) as CSV.

notify(message)[source]

Send the email notification.

Parameters

message (str) – The notification’s message.