Metadata-Version: 2.5
Name: reywechat-hook
Version: 1.0.13
Summary: WeChat client Hook package based on port communication.
Project-URL: Homepage, https://www.reyxbo.com/release/python/reywechat-hook
Project-URL: Repository, https://github.com/reyxbo/reywechat-hook-py.git
Author-email: Rey <reyxbo@163.com>
License: Copyright 2025 ReyXBo
        
        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.
License-File: LICENSE
Keywords: client,hook,receive,rey,reyxbo,robot,send,wechat
Requires-Python: >=3.12
Description-Content-Type: text/markdown

[中文](README_zh.md)

# reywechat-hook

**reywechat-hook** is a WeChat client Hook package based on port communication.

This package provides WeChat client Hook functionality. It enables control and interaction with the WeChat client through port communication and can be used together with the **reywechat** WeChat client control framework.

> **Note:** reywechat-hook must run in a **32-bit Python** environment and requires the **32-bit WeChat client version 4.1.2.17** to be installed.

## Features

* Provides WeChat client Hook functionality
* Supports communication through ports
* Supports WeChat client control and interaction
* Provides a unified WeChat client Hook object
* Supports Hook injection
* Supports Hook status management
* Supports retrieving WeChat client status
* Provides port communication functionality
* Can be used with the `reywechat` control framework
* Supports independently starting the Hook communication service

---

## Installation

Requires **Python 3.12 or higher**.

The following runtime requirements must also be met:

* **32-bit Python**
* **32-bit WeChat client version 4.1.2.17**

Installation:

```bash
pip install reywechat-hook
```

---

## Quick Start

The basic startup method is:

```python
from reywechat_hook import WeChatHook

hook = WeChatHook()

hook.start_socket()
```

Where:

* `WeChatHook`: The WeChat client Hook object provided by reywechat-hook
* `start_socket()`: Starts the port communication service, allowing other programs to communicate with the Hook program through the port

After starting the Hook program, it can be used together with the `reywechat` package to control and interact with the WeChat client through port communication.

> **Note:** The Hook program must be started using **32-bit Python**, and the system must have the **32-bit WeChat client version 4.1.2.17** installed.

---

# Folders

reywechat-hook contains files required for running the Hook program.

## `data` — Data files

**Data file directory.**

Used to store the DLL files required by the Hook program.

These files provide the program components required for hooking the WeChat client.

---

# Modules

reywechat-hook is divided into multiple modules by functionality. Each module provides different Hook and communication capabilities.

## `rall` — All import methods

**Unified import module.**

Provides convenient exports for all methods and objects in reywechat-hook. This module allows framework functionality to be imported from a single location, reducing the need to import from multiple modules separately.

---

## `rbase` — Base methods

**Base module.**

Provides dependency methods and basic functionality shared by other modules.

It is mainly used to provide common dependencies and basic processing capabilities for other modules.

---

## `rhook` — Hook methods

**WeChat client Hook module.**

Provides the WeChat client Hook object and serves as the primary functional module of reywechat-hook.

Main features include:

* WeChat client Hook injection
* Hook status management
* WeChat client status retrieval
* Port communication
* WeChat client control
* Hook program runtime management

Through the Hook object, WeChat client Hook injection and port communication with other programs can be performed.

---

# Module Overview

| Module  | Function                                           |
| ------- | -------------------------------------------------- |
| `rall`  | Unified export of all methods                      |
| `rbase` | Base methods and common dependencies               |
| `rhook` | WeChat client Hook, status, and port communication |

---

# Dependencies

This package has no Python third-party dependencies.

The following runtime requirements must be met:

* **Python 3.12 or higher**
* **32-bit Python**
* **32-bit WeChat client version 4.1.2.17**

---

# Project Information

| Project    | Information                                                          |
| ---------- | -------------------------------------------------------------------- |
| Name       | `reywechat-hook`                                                     |
| Version    | `1.0.12`                                                             |
| Python     | `>=3.12`                                                             |
| Author     | `Rey`                                                                |
| Email      | `reyxbo@163.com`                                                     |
| Homepage   | [reyxbo.com](https://www.reyxbo.com/release/python/reywechat-hook)   |
| Repository | [reywechat-hook-py](https://github.com/reyxbo/reywechat-hook-py.git) |

## Keywords

`rey` · `reyxbo` · `wechat` · `robot` · `receive` · `send` · `client` · `hook`
