imgclickflow 0.1.0__tar.gz

imgclickflow-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+*.egg
+build/
+dist/
+.eggs/
+.venv/
+venv/
+env/
+.pytest_cache/
+.mypy_cache/
+*.whl
+*.tar.gz
+
+# 运行期数据目录（不应入库）
+templates/
+logs/
+error_snapshots/
+screenshots_author/
+*_操作截屏/

imgclickflow-0.1.0/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+本项目遵循 [语义化版本](https://semver.org/lang/zh-CN/)。
+
+## [0.1.0] - 2026-10-03
+
+从单文件脚本改造为可 `pip install` 的包。
+
+### 新增
+
+- `src/` 布局的正式包结构，`pyproject.toml`（hatchling 后端）。
+- `paths.py`：数据目录三级回退（环境变量 → cwd 兼容 → 用户可写目录）。
+- `cli.py`：`imgclickflow doctor / capture / run / help` 与 `--version`，
+  同时支持 `python -m imgclickflow`。
+- `init(data_dir=..., verbose=...)`：显式初始化入口。
+- 冒烟测试：`tests/`。
+
+### 变更
+
+- **移除导入时的自动 `pip install`**。原实现会在 `import` 阶段检查并静默安装
+  缺失依赖 —— 包模式下这是反模式（pip 安装的包不应修改运行环境），且在
+  PEP 668、只读容器、无外网环境下必然失败。现改为抛出带安装提示的
+  `ImportError`。
+- **数据目录不再跟随 `__file__`**。原实现把 `templates/`、`logs/` 等建在
+  代码所在目录；包化后会落到 site-packages（升级被清空、多用户污染、
+  无写权限）。现统一走 `paths.data_dir()`，并保留「当前目录已有 `templates/`」
+  的旧用法。
+- **目录创建与文件日志改为惰性初始化**。`import` 阶段不再创建任何目录、
+  不再挂载文件日志；首次真正落盘时才执行。
+- **移除 `__main__` 中打印整篇使用手册的行为**，改由 CLI 承担。
+- **调试录像不再依赖 `__main__.__file__`** 决定目录，统一落在数据目录下；
+  顺带修复了传入 `task_name` 时引用未定义 `__main__` 导致的 `NameError`。
+- **DPI 感知增加返回值检查**，并补上非 Windows 平台的明确报错。
+
+### 备注
+
+- 包版本自 `0.1.0` 起。原脚本内的 `auto.version = "1.2.0"` 为作者自用版本号，
+  包化后在 `__init__.py` 中与包版本对齐。

imgclickflow-0.1.0/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in 
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

imgclickflow-0.1.0/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.5
+Name: imgclickflow
+Version: 0.1.0
+Summary: 基于图像识别的 Windows 桌面自动化助手：截图即模板，一次编写随处运行
+Project-URL: Homepage, https://github.com/honggescripts/ImgClickFlow
+Project-URL: Repository, https://github.com/honggescripts/ImgClickFlow
+Project-URL: Issues, https://github.com/honggescripts/ImgClickFlow/issues
+Project-URL: Changelog, https://github.com/honggescripts/ImgClickFlow/blob/main/CHANGELOG.md
+Author: yushihong
+License-Expression: MPL-2.0
+License-File: LICENSE
+Keywords: automation,gui-automation,image-recognition,opencv,rpa,template-matching,windows
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Desktop Environment
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.20
+Requires-Dist: opencv-python>=4.5
+Requires-Dist: pillow>=8.0
+Requires-Dist: pywin32>=300; sys_platform == 'win32'
+Description-Content-Type: text/markdown
+
+# ImgClickFlow
+
+基于图像识别的 **Windows 桌面自动化助手**。截图即模板，一行代码点按钮。
+
+面向**没有 API、没有网页、只有图形界面**的老式 Windows 客户端：内网 ERP、
+财务/政务系统、医院 HIS 等。全部计算在本机完成，**不联网、不上传任何数据**。
+
+```python
+import imgclickflow
+
+imgclickflow.auto.click("保存")
+```
+
+## 安装
+
+```bash
+pip install imgclickflow
+```
+
+- **仅支持 Windows**（依赖 Win32 API 完成屏幕捕获与窗口操作）
+- 需要 Python 3.9 及以上
+- 依赖：`numpy` / `opencv-python` / `Pillow` / `pywin32`
+
+## 快速上手
+
+**1. 采集按钮模板** —— 把要点的按钮截成 PNG：
+
+```bash
+imgclickflow capture 保存
+```
+
+该命令会全屏截图并提示你用画图工具裁剪到只剩按钮，保存到数据目录的
+`templates/保存.png`。
+
+> ⚠️ 模板**必须是 PNG**。JPG 的有损压缩会让像素产生偏移，导致匹配失败。
+
+**2. 写流程脚本** `my_flow.py`：
+
+```python
+import imgclickflow
+
+imgclickflow.auto.click("登录")
+imgclickflow.auto.write("用户名")
+imgclickflow.auto.press("tab")
+imgclickflow.auto.write("密码")
+imgclickflow.auto.click("确定")
+```
+
+**3. 运行**：
+
+```bash
+imgclickflow run my_flow.py
+```
+
+## 数据目录
+
+模板、日志、截图、报告都放在**数据目录**下，解析优先级：
+
+| 顺序 | 来源 | 说明 |
+|---|---|---|
+| 1 | 环境变量 `IMGCLICKFLOW_HOME` | 多环境隔离与测试 |
+| 2 | 当前目录已存在 `templates/` | 兼容「脚本与模板放一起」的老用法 |
+| 3 | `%LOCALAPPDATA%\ImgClickFlow` | 默认位置 |
+
+数据**绝不写进 site-packages** —— 那里升级即清空、多用户互相污染、
+系统级安装下还可能没有写权限。
+
+固定数据目录：
+
+```python
+import imgclickflow
+imgclickflow.init(data_dir=r"D:\my_flows")
+```
+
+## 命令行
+
+```bash
+imgclickflow doctor           # 环境诊断：分辨率、DPI、依赖、模板目录
+imgclickflow capture <名称>    # 采集一个按钮模板
+imgclickflow run <脚本>        # 运行流程脚本
+imgclickflow help             # 完整使用手册
+imgclickflow --version
+```
+
+也支持 `python -m imgclickflow`。
+
+## 常用 API
+
+| 方法 | 作用 |
+|---|---|
+| `click(名称)` / `dclick` / `rclick` | 单击 / 双击 / 右键 |
+| `write(文本)` | 输入文本 |
+| `press(键)` / `hotkey(*键)` | 按键 / 组合键 |
+| `wait(名称, timeout=)` | 等待元素出现 |
+| `if_see(名称)` / `else_do()` / `endif()` | 条件分支 |
+| `for_data(列表)` / `end_for()` | 循环 |
+| `find_all(名称)` | 返回全部坐标（批量） |
+| `snap(备注)` | 保存当前屏幕截图 |
+| `cron("17:30", 函数)` | 定时执行 |
+
+链式编排：
+
+```python
+imgclickflow.auto.do() \
+    .click("查询") \
+    .wait("结果列表") \
+    .click("导出") \
+    .run()
+```
+
+## 环境诊断
+
+```bash
+imgclickflow doctor
+```
+
+会打印物理/逻辑分辨率、DPI 缩放系数、依赖状态、模板目录与模板健康情况。
+**换到新机器后建议先跑一次**，确认模板与缩放是否仍然匹配。
+
+## 已知限制
+
+- **仅 Windows**，非 Windows 平台 `import` 会直接报错说明原因。
+- **仅支持主显示器**：程序不抓取副屏内容，多屏环境下请把目标窗口放在主屏。
+- **界面改版后模板会失效**：主题换色、控件位移、缩放比例变化都需要重新采集模板。
+- 需要程序自身具备 DPI 感知能力；若被其他已设置 DPI 感知的宿主进程加载，
+  缩放补偿可能不生效。
+
+## 许可
+
+MPL-2.0（Mozilla Public License 2.0）。可商用、可与闭源代码一起分发；
+但**修改本项目文件本身**时，需公开该文件的改动。