GNTP Python 库技术文档

1. 安装指南

安装 GNTP Python 库非常简单，您可以使用 pip 进行安装：

pip install gntp

安装完成后，您可以运行以下命令来测试模块是否正确安装：

python -m gntp.notifier

2. 项目的使用说明

本项目为 Python 库，用于与 Growl Notification Transport Protocol (GNTP) 交互。下面是一个简单的使用示例。

首先，配置日志记录器：

import logging
logging.basicConfig(level=logging.INFO)

然后，可以使用以下代码发送一个简单的通知：

import gntp.notifier

gntp.notifier.mini("这里是一条快速消息")

如果要发送更复杂的通知，您可以创建一个 GrowlNotifier 实例并使用它发送通知：

growl = gntp.notifier.GrowlNotifier(
    applicationName = "我的应用名称",
    notifications = ["新更新", "新消息"],
    defaultNotifications = ["新消息"],
    # hostname = "computer.example.com", # 默认为 localhost
    # password = "abc123" # 默认为空密码
)
growl.register()

# 发送一条消息
growl.notify(
    noteType = "新消息",
    title = "您有一条新消息",
    description = "一条较长的消息描述",
    icon = "http://example.com/icon.png",
    sticky = False,
    priority = 1,
)

# 尝试发送不同类型的通知
# 这条可能会失败，因为它不在默认通知列表中
growl.notify(
    noteType = "新更新",
    title = "有新的更新可以下载",
    description = "一条较长的消息描述",
    icon = "http://example.com/icon.png",
    sticky = False,
    priority = -1,
)

请注意，对于 Growl 1.4 的 OSX 版本，基于 URL 的图片可能无法工作。您可以在通知中发送图片来解决这个问题：

image = open('/路径/到/图片.png', 'rb').read()
growl.notify(
    noteType = "新消息",
    title = "您有一条新消息",
    description = "这次我们嵌入图片",
    icon = image,
)

3. 项目API使用文档

本项目提供的 API 非常直观。以下是一些主要类的简要描述：

• GrowlNotifier: 用于注册和发送通知。
• mini: 用于快速发送通知的简便方法。

关于 API 的详细信息，请参考官方文档。

4. 项目安装方式

如前所述，项目的安装方式是通过 pip 进行安装：

pip install gntp

以上就是 GNTP Python 库的技术文档，希望能帮助您更好地了解和使用本项目。