nonebit-plugin-litestore

✨ 新一代的轻量化 NoneBot 本地数据存储插件 ✨

Caution

警告，本插件不是NoneBot2规范，商店插件请统一使用 LocalStore

Important

感谢 NoneBot Plugin LocalStore（Worked by yanyongyu）！

本项目在其原有代码的基础上、基于个人的需求，对插件进行更改。

📖 介绍

为了更加方便管理插件数据，开箱即用，

本插件提供了与 NoneBot Plugin LocalStore 不同的功能：

• 无需配置，开箱即用
• 自动在NoneBot2规范机器人项目内创建插件数据主文件夹
• 更加清晰的插件数据路径创建

🔧 使用方式

加载插件后使用 require 声明插件依赖，直接使用 nonebot_plugin_litestore 插件提供的类即可。

from pathlib import Path
from nonebot import require

require("nonebot_plugin_litestore")

from nonebot_plugin_litestore import PluginStore as Store

plugin_cache_dir: Path = Store.Cache.get_dir()
plugin_cache_file: Path = Store.Cache.get_file("filename")
plugin_config_dir: Path = Store.Config.get_dir()
plugin_config_file: Path = Store.Config.get_file("filename")
plugin_data_dir: Path = Store.Data.get_dir()
plugin_data_file: Path = Store.Data.get_file("filename")

💡 存储路径

对于一个规范的NoneBot2项目，本插件会在您的插件调用函数时，自动在项目目录中创建插件数据路径。

比如：

项目目录：YourBot（包含.env文件）

则对应的路径为：./YourBot/__plugin_data__

---

假设你有一个叫 example_plugin 的插件调用了 Store.Data.get_dir(),则对应创建路径为：./YourBot/__plugin_data__/example_plugin/data

同理，本插件一共会创建以下路径：

./YourBot/__plugin_data__/example_plugin/data
./YourBot/__plugin_data__/example_plugin/cache
./YourBot/__plugin_data__/example_plugin/config

💿 安装

使用 nb-cli 安装

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

nb plugin install nonebit-plugin-litestore

使用包管理器安装

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

pip

pip install nonebit-plugin-litestore

pdm

pdm add nonebit-plugin-litestore

poetry

poetry add nonebit-plugin-litestore

conda

conda install nonebit-plugin-litestore

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

plugins = ["nonebit_plugin_litestore"]