Metadata-Version: 2.3
Name: whiskerRAG
Version: 0.0.1a3
Summary: A utility package for RAG operations
Author: petercat.ai
Author-email: antd.antgroup@gmail.com
Requires-Python: >=3.8.1,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: PYGithub (==2.3.0)
Requires-Dist: langchain (>=0.2.12,<0.3.0)
Requires-Dist: langchain_community (>=0.2.11,<0.3.0)
Requires-Dist: langchain_core (>=0.2.28,<0.3.0)
Requires-Dist: langchain_openai (>=0.1.20,<0.2.0)
Description-Content-Type: text/markdown

# WhiskerRAG-toolkit
petercat、whisker 项目使用的 rag 工具包，提供 rag 相关类型定义和方法

## 使用方式
```
pip install whiskerRAG
```
提供两个模块，分别是 whisker_rag_type、 whisker_rag_util

```
from whiskerRAG.github.fileLoader import GithubFileLoader
```


## 开发指南
安装 poetry 进行依赖管理

```bash
pip install poetry
```

项目根目录下安装依赖

```bash
poetry install
```

## 本地测试

```bash
# 运行测试
poetry run pytest

# 带覆盖率报告
poetry run pytest --cov

# 查看HTML格式的覆盖率报告
poetry run pytest --cov --cov-report=html
open htmlcov/index.html

```

# 构建并发布

```bash
poetry build

poetry publish
```

