[!WARNING]
v1 版本已重构,基于 HTTP/2
aiohttp 替换为 httpx
📖 介绍
一个基于 https://clist.by v4 接口,提供 OI/ACM 相关信息查询的 nonebot2 插件。
扩展内容:
- 获取 LeetCode 每日一题
- ...
💿 安装
使用 nb-cli 安装
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-oi-helper
使用包管理器安装
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
pip
pip install nonebot-plugin-oi-helper
pdm
pdm add nonebot-plugin-oi-helper
poetry
poetry add nonebot-plugin-oi-helper
conda
conda install nonebot-plugin-oi-helper
打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分追加写入
plugins = ["nonebot_plugin_oi_helper"]
⚙️ 配置
在 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 文件里:
# nonebot-plugin-oi-helper 配置
CLIST__USERNAME=talentestors
CLIST__USER_KEY=b4c1d76de149ef89cf0542b59a567f7c6b4af952
# clist API 地址
# CLIST_API__REQ_URL=
如何获取 clist 的 key?
点击展开
-
进入 CLIST 官网:https://clist.by/
-
如果你是新用户,你需要新建一个账户。
-
前往 https://clist.by/api/v4/doc/ 页面也可以从这里进去:
-
点 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 项,能筛选对应的平台。
🎉 使用
Metadata
Release files for nonebot-plugin-oi-helper 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nonebot_plugin_oi_helper-2.0.0.tar.gz | 14.1 kB | Without provenance | Details for nonebot_plugin_oi_helper-2.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nonebot_plugin_oi_helper-2.0.0-py3-none-any.whl | Python 3 | none | any | Details for nonebot_plugin_oi_helper-2.0.0-py3-none-any.whl |
Total release size: 35.4 kB
Release files / nonebot_plugin_oi_helper-2.0.0.tar.gz
| Download URL | nonebot_plugin_oi_helper-2.0.0.tar.gz |
|---|---|
| Size | 14.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
80b775ca7af973fcfc8aa1ca8eb69209678d29271c3335a922300366b2780681
|
|
BLAKE2b-256 checksum How to use checksums |
9126b4a970afcf191fdfa96f357c20688c3e5d7d017e4fce03ddd81592c474e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / nonebot_plugin_oi_helper-2.0.0-py3-none-any.whl
| Download URL | nonebot_plugin_oi_helper-2.0.0-py3-none-any.whl |
|---|---|
| Size | 21.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b9eea5d559ce17f48e2fa79a71613f856f95a8814d37d7298a4af62c48955f5b
|
|
BLAKE2b-256 checksum How to use checksums |
58a15b59812084ea6409b46744f34374d616e61b7ef8e9fc22dca8035dc177e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for nonebot-plugin-oi-helper 2.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.