nonebot-plugin-oi-helper 0.5.0

A NoneBot2 plugin for querying OI/ACM related information, including LeetCode daily question and Luogu daily report.

nonebot-plugin-OI-helper

✨ 一个提供 OI/ACM 相关信息的 nonebot2 插件 ✨

📖 介绍

一个基于 https://clist.by v4 接口，提供 OI/ACM 相关信息查询的 nonebot2 插件。

扩展内容：

• 获取 LeetCode 每日一题
• 获取 洛谷日报
• ...

💿 安装

使用 nb-cli 安装

在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

nb plugin install nonebot-plugin-oi-help # 未上架商店

使用包管理器安装

在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

pip

pip install nonebot-plugin-oi-help

pdm

pdm add nonebot-plugin-oi-help

poetry

poetry add nonebot-plugin-oi-help

conda

conda install nonebot-plugin-oi-help

uv

Documents: https://docs.astral.sh/uv/

uv add nonebot-plugin-oi-help

打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分追加写入

plugins = ["nonebot-plugin-oi-help"]

⚙️ 配置

在 nonebot2 项目的 .env 文件中添加下表中的必填配置

[!TIP] 需要使用 aiohttp 的驱动器

配置项	必填	默认值	说明
CLIST__USERNAME	是	无	你的clist用户名
CLIST__USER_KEY	是	无	你的 key
CLIST_API__REQ_URL	否	https://clist.by:443/api/v4/contest/?upcoming=true&filtered=true&order_by=start&format=json	自定义查询url

例如在你的 .env 文件里：

# OI-helper 配置
CLIST__USERNAME=talentestors
CLIST__USER_KEY=cc4a4d946b628bfbd606b75417daf496bac7e200
# clist API 地址
# CLIST_API__REQ_URL=

如何获取 clist 的 key？

点击展开

1. 进入 CLIST 官网：https://clist.by/

2. 如果你是新用户，你需要新建一个账户。

3. 前往 https://clist.by/api/v4/doc/ 页面也可以从这里进去：

4. 点 here 获取你的 API KEY

   Accessing the API requires an API key, which is available to authenticated users here.

   

关于 Filter

点击展开

默认的 clist 的 url 加入了，filtered=true 参数。

这意味着你可以在你的账户里面直接配置规则，而不用设置复杂的 url 请求参数。

https://clist.by/settings/filters/

点击 create 去创建一个规则

Resources 项，能筛选对应的平台。

🎉 使用

See docs