notify package

Submodules

notify.client module

Client-side notification API for compute hosts.

class notify.client.NotifyClient(server_url: str | None = None, token: str | None = None, timeout: float | None = None)

ベースクラス: object

Small HTTP client used from calculation scripts.

send(title: str, body: str = '', strict: bool = False) → bool

Send a notification. Failure is isolated unless strict=True.

validate() → None

notify.client.configure(server_url: str, token: str, timeout: float = 10.0) → None

Set default client settings used by notify().

notify.client.notify(title: str, body: str = '', strict: bool = False, server_url: str | None = None, token: str | None = None, timeout: float | None = None) → bool

Send a notification with a one-call API.

notify.install module

インストール済みの共有データからサンプルスクリプトを配置する。

notify.install.main() → None

notify.server module

REST notification server intended to run on the user's PC.

class notify.server.NotifyConfig(token: str | None = None, backend: str | None = None, mail_client: str | None = None, mail_to: str | None = None, smtp_host: str | None = None, smtp_port: int | None = None, smtp_user: str | None = None, smtp_password: str | None = None)

ベースクラス: object

Server settings. Direct values take priority over environment variables.

validate_common() → None

validate_mail_client() → None

validate_smtp() → None

class notify.server.NotifyMessage(*, title: str, body: str = '')

ベースクラス: BaseModel

body: str

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

title: str

notify.server.escape_applescript_text(text: str) → str

notify.server.get_config() → NotifyConfig

notify.server.main(config: NotifyConfig | None = None, host: str | None = None, port: int | None = None) → None

notify.server.receive_notify(message: NotifyMessage, x_notify_token: str = Header()) → Dict[str, Any]

notify.server.send_by_mail_app(config: NotifyConfig, title: str, body: str) → None

notify.server.send_by_mail_client(config: NotifyConfig, title: str, body: str) → None

notify.server.send_by_outlook_app(config: NotifyConfig, title: str, body: str) → None

notify.server.send_by_outlook_mac(config: NotifyConfig, title: str, body: str) → None

notify.server.send_by_outlook_windows(config: NotifyConfig, title: str, body: str) → None

notify.server.send_by_smtp(config: NotifyConfig, title: str, body: str) → None

notify.server.send_notification(config: NotifyConfig, title: str, body: str) → None