Skip to main content

NoneBot 插件:提供农历黄历信息和实时新闻图片功能

Project description

nonebot-plugin-xisoul

License Python Version NoneBot Version

NoneBot 插件:提供农历黄历信息和实时新闻图片功能,以及Ollama对话功能

功能介绍

  • 📅 获取当天农历黄历信息(文本版和图片版)
  • 📰 获取实时热榜新闻图片
  • ⏰ 支持定时发送新闻图片到指定群聊
  • 💾 支持本地缓存,避免频繁调用API
  • 💬 集成Ollama对话功能(需要单独安装依赖)
  • 更多功能更新中~~~ 🌱

安装

# 使用 nb-cli 安装
nb plugin install nonebot-plugin-xisoul

# 或使用 pip 安装
pip install nonebot-plugin-xisoul

依赖说明

核心依赖(自动安装)

  • nonebot2>=2.0.0 - 插件基础框架
  • nonebot-adapter-onebot>=2.3.0 - OneBot协议适配器
  • nonebot-plugin-apscheduler>=0.1.2 - 定时任务支持
  • httpx>=0.23.0 - HTTP请求客户端

可选依赖(需要手动安装)

  • 网页渲染依赖nonebot-plugin-htmlrender - 用于生成黄历图片(可通过 nb plugin install nonebot-plugin-htmlrender 安装)
  • Ollama对话依赖ollama - 用于Ollama聊天功能(可通过 pip install ollama 安装)

配置项

可能会有多个网站的APIKEY所以通过网站名字命名 SHWGIJapi网址:https://api.shwgij.com/

.env.prod 文件中添加以下配置:

# 黄历API配置
LUNAR_CALENDAR_API_KEY="您的API密钥"

# 新闻API配置
# 新闻更多配置请直接参考官方文档,如果你的配置获取不到API可以自行下载插件用AI帮你修改代码
SHWGIJ_API_KEY="您的新闻API密钥"

# 定时任务配置
# 格式: 分 时 日 月 周
SHWGIJ_CRON_EXPRESSION="0 8 * * *"
# 定时任务发送的群聊ID列表,多个群ID用逗号分隔
SHWGIJ_SEND_GROUPS="群聊ID1,群聊ID2"
# 是否启用定时任务,1-启用,0-禁用
SHWGIJ_CRON_ENABLE=1

# 日志级别配置 (可选:DEBUG, INFO, WARNING, ERROR)
SHWGIJ_LOG_LEVEL="INFO"
# 图片删除延时时间(秒)
SHWGIJ_IMAGE_DELETE_DELAY=120
# 缓存文件保留天数
SHWGIJ_CACHE_EXPIRE_DAYS=7

# Ollama配置(可选,如果需要使用聊天功能)
OLLAMA_API_KEY="您的Ollama API密钥(如果有)"

使用说明

黄历功能

  • 文本版黄历:发送 文字黄历文本黄历(无需 / 前缀)
  • 图片版黄历:发送 黄历(无需 / 前缀)
  • 兼容原有命令格式:/文字黄历@机器人 文字黄历/黄历 仍然可用

新闻功能

  • 热榜新闻图片:发送 /新闻图片 获取今日热榜新闻图片

帮助功能

  • 获取所有命令帮助:发送 帮助插件帮助xihelp(无需 / 前缀),或使用 /帮助/插件帮助/xihelp

测试功能

  • 插件功能测试:发送 /测试黄历 测试插件功能

Ollama聊天功能(扩展功能)

注意:使用此功能前请先安装Ollama依赖 (pip install ollama)

  • 清理对话历史:发送 /清理历史/重置对话
  • 更多Ollama相关命令请参考插件内部实现

许可证

本项目使用 MIT 许可证

致谢

感谢所有为本项目做出贡献的开发者!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nonebot_plugin_xisoul-0.1.0.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nonebot_plugin_xisoul-0.1.0-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file nonebot_plugin_xisoul-0.1.0.tar.gz.

File metadata

  • Download URL: nonebot_plugin_xisoul-0.1.0.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for nonebot_plugin_xisoul-0.1.0.tar.gz
Algorithm Hash digest
SHA256 40267974318870dd4b56983c70ef59933dd7c2bee8a6e6659f9b7aa44aa44bba
MD5 02ff28a38a9d1c1592aec853c879b360
BLAKE2b-256 d0feb7848bbbc04d980162f67506c7c35df2e05f786b466d801b04e89bf9830e

See more details on using hashes here.

File details

Details for the file nonebot_plugin_xisoul-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_plugin_xisoul-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd4ce262fa6771b4105088c636986401d7e84dab39124174ddd8cb4f394432f5
MD5 9c98e4b865867c9e5926b2f3cfa9d239
BLAKE2b-256 3b81b6f4edf07547113bdde7cec31629cc70ba9681b1175aba0346bf264ea2c5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page