Miose Toolkit - Python 开发工具箱

介绍

Miose Toolkit 是一个基于 Python 的个人工具箱，收集了一些个人常用的小工具，方便快速开发。为了提高工具库可用性，大部分工具都包含了自动化测试用例，包含 Windows, Linux, MacOS 的多平台一致性测试。

该工具库会持续处于开发阶段，如果需要使用建议锁定版本号，以免出现不兼容问题。

工具列表

工具名称	简介	文档	Release
通用工具集	包含配置文件工具, 指令解析工具等	common
数据库 ORM 工具	一个对 sqlalchemy 进行了简单封装的数据库工具	db
日志工具	一个基于 loguru 的日志工具	logger
LLM 开发框架	一套组件化、工程化的 LLM 项目开发框架	llm

计划中工具列表

• image - 图片处理工具集

如果你有好的想法，欢迎提出 issue 或者 PR。

安装 (以 logger 为例)

pip install miose-toolkit-logger  # 安装日志工具

使用

from miose_toolkit_logger import logger

logger.info('Hello Miose Toolkit !')

开发指南

如果你想为 Miose Toolkit 贡献代码，可以参考以下步骤：

0. 提交 issue

如果你希望你的代码被合并到主分支发布，请先提交 issue 说明你的想法，避免重复劳动或功能冲突。

1. 克隆代码

建议先 fork 项目到自己的仓库，然后再克隆自己仓库的代码。

git clone https://github.com/KroMiose/miose-toolkit.git

2. 安装开发环境依赖

poetry install --dev

3. 安装子项目依赖

poetry run install  # 安装所有子项目依赖
poetry run install common  # 安装 common 子项目依赖

4. 运行测试

Miose Toolkit 使用 pytest 作为测试框架，可直接使用 VSCode 等 IDE 集成测试工具单独或批量运行测试用例。

poetry run pytest # 运行所有测试

5. 调试代码 (推荐使用 VSCode)

项目中包含了 VSCode 的调试配置，可以使用 VSCode 调试面板选择在对应的测试用例中运行 "Debug: Current File" (需要视实际需求添加用例的调用代码)。

6. 提交代码

该项目代码在提交到所在仓库主分支后会自动进行多平台测试，如果测试通过欢迎提交 PR ~

其它: 清理环境

如果你在开发过程中遇到了问题，例如依赖包冲突等，可以尝试清理环境后重新安装依赖。

poetry run clean # 清理所有子项目环境
poetry run clean common # 清理 common 子项目环境

如果运行以上代码时因为权限问题导致失败，可以尝试直接到对应子项目目录下删除 .venv 文件夹。

🤝 贡献列表

感谢以下开发者对本项目做出的贡献