Metadata-Version: 2.4
Name: mxboxutils
Version: 0.1.5
Summary: An utils collection for python called MxBoxUtils
Author-email: RyanLu <lyydev@qq.com>
License: MIT License
        
        Copyright (c) 2025 Ryan
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://gitee.com/RyanLuDev/MxBoxUtils
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: build; extra == "dev"
Dynamic: license-file

# MxBoxUtils

MxBoxUtils 是一个Python工具库，提供了文件操作、TOML配置解析等实用功能。

## 目录结构

```
MxBoxUtils/
├── src/
│   └── mx/             # 核心功能模块
│       ├── __init__.py # 包初始化文件
│       ├── file.py     # 文件操作工具
│       └── toml.py     # TOML配置文件解析工具
├── LICENSE             # 许可证文件
├── pyproject.toml      # 项目配置文件
└── README.md           # 项目说明文档
```

## 功能模块

### 1. 文件操作 (file.py)

提供文件和目录操作相关的功能。

#### files(f_path: str, f_ext: list[str]) -> list[str]
列出指定目录下的所有指定扩展名的文件名。
- **参数**: 
  - `f_path` - 目录路径
  - `f_ext` - 要匹配的文件扩展名列表（不包含点号）
- **返回值**: 包含所有匹配文件名的列表

#### 其他函数（待实现）
- `file_paths()` - 获取文件路径
- `images()` - 处理图像文件
- `image_paths()` - 获取图像文件路径
- `file_hash()` - 计算文件哈希值

### 2. TOML配置解析 (toml.py)

提供TOML配置文件解析功能。

#### load_toml(filepath)
加载TOML文件并返回解析后的数据。
- **参数**: 
  - `filepath` - TOML文件的路径
- **返回值**: 解析后的TOML数据字典，如果文件不存在则返回None

## 安装说明

```bash
# 从源代码安装
git clone https://gitee.com/RyanLuDev/MxBoxUtils
cd MxBoxUtils
pip install -e .
```

## 版本信息

当前版本: 0.1.5

## 系统要求

- Python 3.14 或更高版本

## 依赖

- pillow (图像处理相关功能需要)

## 开发依赖

- pytest
- twine
- build

## 贡献

欢迎提交Issue和Pull Request来帮助改进这个项目。

## 许可证

MIT License
