nonebot-plugin-litestore 0.1.1

A Lighter LocalStore For NoneBot2

nonebit-plugin-litestore

✨ 轻量化 NoneBot 本地数据存储插件 ✨

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

[!IMPORTANT] 感谢项目 NoneBot Plugin LocalStore

本项目在其基础上对插件进行更改。

📖 介绍

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

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

• 无需配置，开箱即用
• 自动创建插件数据存储路径
• 创建更加清晰的插件数据路径

🔧 使用方式

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

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项目，在NoneBot完成初始化后，调用本插件相关函数时，会自动在.env文件所处目录中创建路径。

比如：

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

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

---

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

---

同理，当你分别调用本插件的不同函数时，会分别创建以下路径：

① ./Awesome/__plugin_data__/setu/data
② ./Awesome/__plugin_data__/setu/cache
③ ./Awesome/__plugin_data__/setu/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"]