Metadata-Version: 2.4
Name: py-easy-tiehu
Version: 1.0.1
Summary: 铁虎停车系统 Python SDK，提供简单易用的铁虎停车系统 API 交互功能，支持与铁虎停车系统的各种操作。
Home-page: https://gitee.com/guolei19850528/py_easy_tiehu
Author: guolei
Author-email: 174000902@qq.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx
Requires-Dist: jsonschema
Requires-Dist: jsonpath-ng
Requires-Dist: py-easy-httpx
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# py_easy_tiehu

铁虎停车系统 Python SDK，提供简单易用的铁虎停车系统 API 交互功能，支持与铁虎停车系统的各种操作。

## 功能特性

- **API 客户端**：提供与铁虎停车系统 API 交互的客户端
- **签名生成**：按照铁虎停车系统 API 要求生成请求签名
- **同步/异步支持**：同时支持同步和异步操作
- **灵活配置**：支持通过参数自定义客户端行为
- **响应处理**：提供 JSON 数据验证功能
- **类型提示**：完整的类型注解，提供良好的 IDE 支持

## 安装

### 使用 pip 安装

```bash
pip install py_easy_tiehu
```

### 从源码安装

```bash
git clone https://gitee.com/guolei19850528/py_easy_tiehu.git
cd py_easy_tiehu
pip install -e .
```

## 依赖

- httpx
- py_easy_httpx

## 快速开始

### 同步请求

```python
from py_easy_tiehu.pklot import Pklot

# 初始化铁虎停车系统客户端
pklot_client = Pklot(
    base_url="https://example.com",
    parking_id="YOUR_PARKING_ID",
    app_key="YOUR_APP_KEY"
)

# 发送同步请求
response = pklot_client.request(
    url="/api/endpoint",
    json={
        "param1": "value1",
        "param2": "value2"
    }
)
print(f"请求结果: {response}")
```

### 异步请求

```python
import asyncio
from py_easy_tiehu.pklot import Pklot

async def main():
    # 初始化铁虎停车系统客户端
    pklot_client = Pklot(
        base_url="https://example.com",
        parking_id="YOUR_PARKING_ID",
        app_key="YOUR_APP_KEY"
    )
    
    # 发送异步请求
    response = await pklot_client.async_request(
        url="/api/endpoint",
        json={
            "param1": "value1",
            "param2": "value2"
        }
    )
    print(f"请求结果: {response}")

asyncio.run(main())
```

## API 文档

### Pklot 类

#### 初始化参数
- `base_url`: 铁虎停车系统的基础 URL
- `parking_id`: 停车场 ID
- `app_key`: 应用密钥，用于签名生成
- `client_kwargs`: 传递给 httpx.Client 的额外参数

#### 方法
- `signature(data=None)`: 生成请求签名
- `request(client=None, **kwargs)`: 同步发送请求
- `async_request(client=None, **kwargs)`: 异步发送请求

## 高级用法

### 自定义客户端配置

```python
from py_easy_tiehu.pklot import Pklot

# 初始化铁虎停车系统客户端，自定义客户端配置
pklot_client = Pklot(
    base_url="https://example.com",
    parking_id="YOUR_PARKING_ID",
    app_key="YOUR_APP_KEY",
    client_kwargs={
        "timeout": 60.0,  # 设置超时时间为 60 秒
        "headers": {
            "User-Agent": "py_easy_tiehu"
        }
    }
)

# 发送请求
response = pklot_client.request(
    url="/api/endpoint",
    json={
        "param1": "value1",
        "param2": "value2"
    }
)
print(f"请求结果: {response}")
```

## 项目结构

```
py_easy_tiehu/
├── py_easy_tiehu/              # 主包目录
│   ├── __init__.py            # 包初始化文件
│   └── pklot.py               # 铁虎停车系统API客户端模块
├── README.md                  # 项目文档
├── setup.py                   # 安装配置
├── requirements.txt           # 依赖列表
├── LICENSE                    # 许可证文件
├── deploy.sh                  # 部署脚本
├── .gitignore                 # Git 忽略文件
└── test_pklot.py              # 测试文件
```

## 测试

运行测试：

```bash
# 运行测试
python test_pklot.py
```

## 许可证

MIT License

## 贡献

欢迎提交 Issue 和 Pull Request！

## 联系方式

- 作者：guolei
- 邮箱：174000902@qq.com
- 项目地址：https://gitee.com/guolei19850528/py_easy_tiehu

## 致谢

- [httpx](https://www.python-httpx.org/) - 高性能的异步 HTTP 客户端库
- [py_easy_httpx](https://gitee.com/guolei19850528/py_easy_httpx) - 简化 HTTP 请求的工具包
