nbnotify 0.1.0

Unified messaging library for Telegram, Discord, and Slack.

nbnotify

A unified Python library for sending messages and images to Telegram, Discord, and Slack — with a single, consistent API.

Perfect for Jupyter notebooks, ML training scripts, or any long-running process where you want real-time notifications.

---

Installation

pip install nbnotify

Or via conda:

conda install -c conda-forge nbnotify

Quickstart

from nbnotify import configure, send_message, send_image

# Pick your platform
configure("telegram", bot_token="YOUR_TOKEN", chat_id="YOUR_CHAT_ID")

send_message("Training complete!")
send_image("results.png", caption="Final accuracy: 98.2%")

Platform Setup

Telegram

1. Create a bot via @BotFather and get your token.
2. Send a message to your bot, then visit https://api.telegram.org/bot<TOKEN>/getUpdates to find your chat_id.

configure("telegram", bot_token="123:ABC...", chat_id="987654321")

Discord

1. Go to your channel → Edit Channel → Integrations → Webhooks → New Webhook.

configure("discord", webhook_url="https://discord.com/api/webhooks/...")

Slack

1. Visit api.slack.com/apps → Incoming Webhooks.

# Text only
configure("slack", webhook_url="https://hooks.slack.com/services/...")

# Text + images (requires bot token)
configure("slack", webhook_url="...", bot_token="xoxb-...", chat_id="#general")

API Reference

configure(platform, *, bot_token, webhook_url, chat_id)

Sets up the active platform. Must be called before any other function.

send_message(text)

Sends a plain-text message. Returns the API response dict.

send_image(image_path, caption=None)

Sends an image file. Optionally attach a caption.

get_config()

Returns the current configuration (tokens are masked).

License

MIT