use-notify

Category: Development & Coding | Uploader: use-py | Downloads: 0 | Version: v1.0（Latest）

Help users integrate and troubleshoot the use-notify Python library. Use when asked about use-notify, @notify, NotificationPublishError, RetryConfig, default notify instances, custom notification channels, or any Bark/Ding/WeChat/WeCom/Email/Chanify/Feishu/Ntfy/PushDeer/PushOver notification setup.

Changelog: Source: GitHub https://github.com/use-py/use-notify

Directory Structure

Current level: Root

📁 .github/
- 📁 workflows/
  - 📄 release.yml 1.1 KB
  - 📄 test.yml 726 B
📁 .vscode/
- 📄 launch.json 594 B
📁 example/
- 📄 current_time_demo.py 2.8 KB
- 📄 decorator_default_instance.py 6.6 KB
- 📄 decorator_demo.py 8.6 KB
- 📄 decorator_real_usage.py 7.5 KB
- 📄 from_setting.py 170 B
- 📄 ntfy_demo.py 5.7 KB
- 📄 ntfy_from_settings.py 1.3 KB
- 📄 ntfy_integration.py 1.2 KB
- 📄 ntfy_simple.py 1.0 KB
📁 skill-references/
- 📄 channels.md 2.5 KB
- 📄 quickstart.md 1.9 KB
- 📄 troubleshooting.md 2.7 KB
📁 src/
- 📁 use_notify/
  - 📁 channels/
    
    📄 __init__.py 349 B
    
    📄 bark.py 1.7 KB
    
    📄 base.py 390 B
    
    📄 chanify.py 1.4 KB
    
    📄 console.py 718 B
    
    📄 ding.py 1.7 KB
    
    📄 email.py 2.7 KB
    
    📄 feishu.py 1.9 KB
    
    📄 ntfy.py 3.4 KB
    
    📄 pushdeer.py 3.3 KB
    
    📄 pushover.py 1.2 KB
    
    📄 wechat.py 1.5 KB
  - 📁 decorator/
    
    📄 __init__.py 726 B
    
    📄 context.py 1.3 KB
    
    📄 core.py 16.1 KB
    
    📄 exceptions.py 319 B
    
    📄 formatter.py 3.8 KB
    
    📄 sender.py 2.9 KB
  - 📄 __init__.py 514 B
  - 📄 notification.py 9.3 KB
📁 tests/
- 📄 __init__.py 42 B
- 📄 conftest.py 126 B
- 📄 helpers.py 1.1 KB
- 📄 test_channels.py 5.5 KB
- 📄 test_decorator.py 8.8 KB
- 📄 test_email.py 2.4 KB
- 📄 test_notification.py 7.7 KB
📄 .gitignore 1.9 KB
📄 Makefile 346 B
📄 pyproject.toml 665 B
📄 README.md 3.6 KB
📄 SKILL.md 2.7 KB
📄 uv.lock 166.0 KB

SKILL.md

---
name: use-notify
description: Help users integrate and troubleshoot the use-notify Python library. Use when asked about use-notify, @notify, NotificationPublishError, RetryConfig, default notify instances, custom notification channels, or any Bark/Ding/WeChat/WeCom/Email/Chanify/Feishu/Ntfy/PushDeer/PushOver notification setup.
---

# use-notify

Use this skill when the user wants to add notifications with `use-notify`, choose a channel, wire `@notify` into existing code, or debug delivery and retry behavior.

## What to read

- For first-time setup, quick snippets, or migration examples, read `skill-references/quickstart.md`.
- For provider-specific configuration, exact class names, and channel keys, read `skill-references/channels.md`.
- For retries, default-instance semantics, errors, and common pitfalls, read `skill-references/troubleshooting.md`.

Read only the references needed for the request.

## Workflow

1. Identify the integration style the user actually needs.
2. Generate code against the current public API in this repo.
3. Prefer the smallest working example that matches the user's stack.
4. Call out behavior that often surprises users, especially retries and error propagation.

## Integration defaults

- Prefer `@notify(...)` when the user wants notifications around function execution.
- Prefer `useNotify()` plus `.add(...)` and `.publish(...)` when the user wants ad hoc sends from scripts, jobs, or services.
- Prefer `useNotify.from_settings(settings)` when the user already has a configuration dict and wants minimal boilerplate.
- If the user does not name a real provider, use `useNotifyChannel.Console()` in examples so the snippet stays runnable without secrets.

## API guardrails

- Use exact exported names: `useNotify`, `useNotifyChannel`, `notify`, `NotificationPublishError`, `RetryConfig`.
- Use exact channel class names: `Bark`, `Chanify`, `Console`, `Ding`, `Email`, `Feishu`, `Ntfy`, `PushDeer`, `PushOver`, `WeChat`, `WeCom`.
- `WeCom` is an alias of `WeChat`.
- Custom channels must implement `send(content, title=None)` and `send_async(content, title=None)`.
- The decorator parameters are `notify_on_success` and `notify_on_error`, not older variants like `on_success` or `on_failure`.
- Do not suggest `notify_on_success=False` and `notify_on_error=False` together; current validation rejects that.
- Default notify instances are scoped to the current execution context, not a process-wide global singleton.

## Response guidance

- Keep examples copy-pasteable.
- When helping with failures, explain whether the user is calling the publisher API directly or using the decorator.
- When the request touches retries or delivery guarantees, explicitly mention how single-channel and multi-channel failures are surfaced.

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

use-notify

Directory Structure

SKILL.md

Report

Notice