Metadata-Version: 2.1
Name: slider-captcha-match
Version: 1.0.2
Summary: Slider Captcha Match 是一个基于 Python 和 OpenCV 的滑块验证码匹配工具，旨在通过对比滑块和背景图像来计算滑块的正确偏移量。该项目主要用于验证图像处理和匹配算法。
License: Apache-2.0
Author: ityangs
Author-email: ityangs@163.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: numpy (>=1.21,<2.0)
Requires-Dist: opencv-python (>=4.5,<5.0)
Description-Content-Type: text/markdown

# Slider Captcha Match

## 项目简介

Slider Captcha Match 是一个基于 Python 和 OpenCV 的滑块验证码匹配工具，旨在通过对比滑块和背景图像来计算滑块的正确偏移量。该项目主要用于验证图像处理和匹配算法。

## 目录结构
```bash
.
├── src
│ ├── data
│ │ ├── bg3.jpeg # 背景图像
│ │ ├── slider3.png # 滑块图像
│ │ ├── output # 生成的输出图像
│ ├── slide_match
│ │ ├── init.py
│ │ └── slide_match.py # 核心算法实现
│ └── test
│ │ └── test_slide_match.py # 测试代码
│ ├── requirements.txt
├── README.md
```

## 安装

1. 克隆仓库到本地：

```bash
git clone https://github.com/ityangs/slider-captcha-match.git
cd slider-captcha-match
```

2. 创建虚拟环境并安装依赖：
```bash
python -m venv venv
source venv/bin/activate  # 在 Windows 上使用 `venv\Scripts\activate`
pip install -r requirements.txt
```

3. 使用 Anaconda 或 Mamba 安装依赖：
```bash
or
mamba create -n slider-captcha-match python=3.10
mamva activate slider-captcha-match
pip install -r requirements.txt

```

## 使用说明

### 核心类 SlideMatch

SlideMatch 类包含了进行滑块匹配的核心方法。

```python
from slide_match.slide_match import SlideMatch

processor = SlideMatch(save_images=True, output_path="output")

# 通过图像路径获取滑块偏移量
offset = processor.get_slider_offset("data/bg3.jpeg", "data/slider3.png")
print(f"Offset (paths): {offset}")

# 通过 base64 编码获取滑块偏移量
background_base64 = "..."  # base64 编码的背景图像
slider_base64 = "..."  # base64 编码的滑块图像
offset = processor.get_slider_offset(background_base64, slider_base64)
print(f"Offset (base64): {offset}")
```


### 测试

项目包含基本的测试代码，测试代码位于 src/test/test_slide_match.py 中，包含了两种测试方法：
通过路径获取滑块偏移量。
通过 base64 编码获取滑块偏移量。
可以直接运行测试文件来查看效果：

```bash
python src/test/test_slide_match.py
```

## 贡献
> 如果你有兴趣为本项目做贡献，请遵循以下步骤：

```bash
1. Fork 本仓库
2. 创建你的 feature 分支 (`git checkout -b feature/fooBar`)
3. 提交你的修改 (`git commit -am 'Add some fooBar'`)
4. 推送到分支 (`git push origin feature/fooBar`)
5. 创建一个新的 Pull Request
```

## 许可证
此项目基于 MIT 许可证，详情请参阅 LICENSE 文件。

## 联系
如果你有任何问题或建议，请通过电子邮件联系我们：ityangs@163.com
