bat2pe 1.4.9__tar.gz

bat2pe-1.4.9/Cargo.lock

@@ -0,0 +1,335 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
+
+[[package]]
+name = "bat2pe"
+version = "0.1.0"
+dependencies = [
+ "bat2pe-core",
+ "serde",
+ "serde_json",
+]
+
+[[package]]
+name = "bat2pe-core"
+version = "0.1.0"
+dependencies = [
+ "serde",
+ "serde_json",
+ "windows-sys",
+]
+
+[[package]]
+name = "bat2pe-py"
+version = "0.1.0"
+dependencies = [
+ "bat2pe-core",
+ "pyo3",
+ "serde",
+ "serde_json",
+]
+
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "itoa"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
+
+[[package]]
+name = "libc"
+version = "0.2.183"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b5b646652bf6661599e1da8901b3b9522896f01e736bad5f723fe7a3a27f899d"
+
+[[package]]
+name = "memchr"
+version = "2.8.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79"
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f402062616ab18202ae8319da13fa4279883a2b8a9d9f83f20dbade813ce1884"
+dependencies = [
+ "cfg-if",
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b14b5775b5ff446dd1056212d778012cbe8a0fbffd368029fd9e25b514479c38"
+dependencies = [
+ "once_cell",
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ab5bcf04a2cdcbb50c7d6105de943f543f9ed92af55818fd17b660390fc8636"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fd24d897903a9e6d80b968368a34e1525aeb719d568dba8b3d4bfa5dc67d453"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "36c011a03ba1e50152b4b394b479826cad97e7a21eb52df179cd91ac411cbfbe"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+
+[[package]]
+name = "serde"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
+dependencies = [
+ "serde_core",
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_core"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad"
+dependencies = [
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_derive"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "serde_json"
+version = "1.0.149"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "83fc039473c5595ace860d8c4fafa220ff474b3fc6bfdb4293327f1a37e94d86"
+dependencies = [
+ "itoa",
+ "memchr",
+ "serde",
+ "serde_core",
+ "zmij",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.12.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"
+
+[[package]]
+name = "windows-sys"
+version = "0.59.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
+dependencies = [
+ "windows-targets",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
+dependencies = [
+ "windows_aarch64_gnullvm",
+ "windows_aarch64_msvc",
+ "windows_i686_gnu",
+ "windows_i686_gnullvm",
+ "windows_i686_msvc",
+ "windows_x86_64_gnu",
+ "windows_x86_64_gnullvm",
+ "windows_x86_64_msvc",
+]
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
+
+[[package]]
+name = "windows_i686_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
+
+[[package]]
+name = "zmij"
+version = "1.0.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b8848ee67ecc8aedbaf3e4122217aff892639231befc6a1b58d29fff4c2cabaa"

bat2pe-1.4.9/Cargo.toml

@@ -0,0 +1,23 @@
+[workspace]
+resolver = "3"
+members = ["crates/bat2pe-core", "crates/bat2pe-py"]
+
+[workspace.package]
+authors = ["Bat2PE Contributors"]
+edition = "2024"
+license = "MPL-2.0"
+rust-version = "1.85"
+version = "0.1.0"
+
+[workspace.dependencies]
+pyo3 = { version = "0.22", features = ["extension-module", "abi3-py310"] }
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+windows-sys = { version = "0.59", features = [
+  "Win32_Foundation",
+  "Win32_Storage_FileSystem",
+  "Win32_System_LibraryLoader",
+  "Win32_System_Console",
+  "Win32_System_Threading",
+  "Win32_UI_WindowsAndMessaging",
+] }

bat2pe-1.4.9/LICENSE

@@ -0,0 +1,5 @@
+Mozilla Public License Version 2.0
+
+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 https://mozilla.org/MPL/2.0/.

bat2pe-1.4.9/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.4
+Name: bat2pe
+Version: 1.4.9
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Rust
+License-File: LICENSE
+Summary: Windows Bat/Cmd to Exe converter with Rust CLI and Python API.
+Author: Bat2PE Contributors
+License: MPL-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# Bat2PE
+
+<div align="center">
+
+![Bat2PE](https://socialify.git.ci/271374667/Bat2PE/image?description=1&language=1&name=1&owner=1&pattern=Plus&theme=Auto)
+
+[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](#quick-start)
+[![Rust](https://img.shields.io/badge/rust-1.85%2B-orange.svg)](#quick-start)
+[![Platform](https://img.shields.io/badge/platform-Windows%2010%2F11-success.svg)](#highlights)
+[![License](https://img.shields.io/badge/license-MPL--2.0-green.svg)](LICENSE)
+
+[English README](README.md) | [中文说明](README_CN.md) | [Python API](docs/python-api.md) 
+
+**Convert `.bat` / `.cmd` scripts to standalone `.exe` via CLI or Python module**  
+**Fully compatible runtime behavior, custom icon & metadata, UAC elevation, passes Kaspersky and common AV scans, zero runtime dependencies**
+
+</div>
+
+> Existing solutions like Bat To Exe Converter fall short for professionals who need to integrate the conversion step into automated workflows. Bat2PE offers no GUI — instead it provides a CLI and a directly callable Python module, letting you convert batch scripts to executables in one command and fold distribution into your pipeline.
+
+Executables generated by Bat2PE behave identically to the original batch script, preserving `%~dp0` and other special variables. You can embed a custom icon, set version info, company name, and other file metadata. One flag adds UAC elevation. The output passes Kaspersky (free edition) and common antivirus scans. The generated `.exe` runs standalone with zero extra dependencies.
+
+## Highlights
+
+- **`build → inspect → verify` pipeline** — generate, examine, and validate without switching tools
+- **`%~dp0` semantics preserved** — temp script is written beside the `.exe`, not in `%TEMP%`, minimizing broken relative paths
+- **Window mode** — defaults to `hidden` (silent background); add `--visible` for a foreground console
+- **Multi-encoding support** — `UTF-8` · `UTF-8 BOM` · `UTF-16 LE BOM` · `ANSI/GBK` auto-detected
+- **Dual entry points** — CLI for terminals and CI/CD, Python API for scripting and automation workflows
+- **Native Windows resource writing** — icon, version number, company name, and other metadata written to PE resource sections, visible in Explorer
+- **UAC elevation** — a single `--uac` or `uac=True` makes the generated `.exe` request admin privileges
+- **AV-friendly** — generated executables pass Kaspersky Free and common antivirus scans
+- **Zero extra dependencies** — generated `.exe` runs standalone, no runtime installation required
+
+## Installation
+
+### Python Users
+
+```bash
+pip install bat2pe
+```
+
+After installation, call `from bat2pe import build` directly in your Python code.
+
+### CLI Users
+
+Download `bat2pe.exe` from [GitHub Releases](https://github.com/271374667/Bat2PE/releases) and you're ready to go.
+
+### System Requirements
+
+| Dependency | Minimum Version |
+|------------|----------------|
+| OS | Windows 10 / 11 (x64) |
+| Python (only for Python API) | 3.10+ |
+| Rust (only for building from source) | 1.85+ |
+
+## Quick Start
+
+### CLI Usage
+
+**Simplest conversion** — one command, generates a same-name `.exe` beside the script:
+
+```powershell
+bat2pe build run.bat
+```
+
+**Specify output path and icon**:
+
+```powershell
+bat2pe build run.bat --output-exe-path dist\run.exe --icon-path app.ico
+```
+
+**Show console window** (for interactive foreground tools):
+
+```powershell
+bat2pe build run.bat --visible
+```
+
+**Add UAC admin elevation**:
+
+```powershell
+bat2pe build admin.cmd --uac
+```
+
+**Write full version metadata**:
+
+```powershell
+bat2pe build run.bat ^
+  --company "Acme Corp" ^
+  --product "My Tool" ^
+  --description "Launcher" ^
+  --file-version 1.2.3 ^
+  --product-version 1.2.3
+```
+
+> 💡 Besides `build`, there are also `inspect` (view exe metadata) and `verify` (check behavioral consistency) subcommands. Run `bat2pe <command> --help` for full details.
+
+### Python Usage
+
+#### Functional API (recommended for quick use)
+
+```python
+from bat2pe import build
+
+result = build(input_bat_path="run.bat")
+print(result.output_exe_path)  # run.exe
+```
+
+#### Object-Oriented API (recommended for complex scenarios)
+
+```python
+from bat2pe import Builder
+
+builder = Builder(
+    input_bat_path="run.bat",
+    output_exe_path="dist/run.exe",
+    # visible defaults to False (hidden); set True for console window
+    icon_path="app.ico",
+    company_name="Acme Corp",
+    product_name="My Tool",
+    file_version="1.2.3",
+)
+result = builder.build()
+```
+
+#### UAC Elevation
+
+```python
+from bat2pe import build
+
+result = build(
+    input_bat_path="admin_task.bat",
+    uac=True,
+)
+```
+
+#### Error Handling
+
+```python
+from bat2pe import build, BuildError, ERR_UNSUPPORTED_INPUT
+
+try:
+    build(input_bat_path="readme.txt")
+except BuildError as e:
+    if e.code == ERR_UNSUPPORTED_INPUT:
+        print("Only .bat or .cmd files are supported")
+    print(e.code, e.path, e.details)
+```
+
+For the full Python API reference (including `inspect`, `verify`, and other advanced usage), see [docs/python-api.md](docs/python-api.md).
+
+## How It Works
+
+Bat2PE embeds a batch script into a native Windows PE executable. At runtime, the generated `.exe`:
+
+1. Reads the embedded script content from its own PE resources
+2. Writes a temporary `.cmd` file (with hidden attribute) in the `.exe`'s directory
+3. Executes the temp script via `cmd.exe /d /c`, forwarding all command-line arguments
+4. Automatically deletes the temp file after execution, with orphan cleanup on abnormal termination
+
+**Why not write to `%TEMP%`?** Because many batch scripts rely on `%~dp0` to locate adjacent config files or resource directories. Placing the temp script beside the `.exe` preserves this semantic as much as possible, keeping behavior consistent with the original script.
+
+### Architecture Overview
+
+```
+┌──────────────┐    ┌──────────────┐    ┌──────────────────┐
+│  CLI Users   │    │ Python Users │    │  CI/CD Pipelines │
+└──────┬───────┘    └──────┬───────┘    └────────┬─────────┘
+       │                   │                     │
+       ▼                   ▼                     ▼
+┌──────────────┐    ┌──────────────┐    ┌──────────────────┐
+│  bat2pe.exe  │    │bat2pe._native│    │  bat2pe (Python)  │
+│  (Rust CLI)  │    │(PyO3 Extension)│  │   pip install     │
+└──────┬───────┘    └──────┬───────┘    └────────┬─────────┘
+       │                   │                     │
+       └───────────────────┴─────────────────────┘
+                           │
+                           ▼
+                  ┌─────────────────┐
+                  │   bat2pe-core   │
+                  │  (Rust Core Lib)│
+                  └─────────────────┘
+```
+
+
+## Building from Source (Developers)
+
+If you want to build from source or contribute:
+
+### Setup
+
+```powershell
+# Install dependencies
+uv sync
+```
+
+### Build All Artifacts
+
+```powershell
+# Recommended (one-step build for CLI + Python extension)
+uv run python scripts/compile.py
+
+# For debug builds
+uv run python scripts/compile.py --debug
+```
+
+Build outputs:
+
+| Artifact | Description |
+|----------|-------------|
+| `target/release/bat2pe.exe` | Standalone CLI program |
+| `python/bat2pe/_native.pyd` | Python native extension module |
+
+### Manual Build
+
+```powershell
+cargo build --release -p bat2pe -p bat2pe-py
+uv run maturin develop
+```
+
+### Running Tests
+
+```powershell
+# Rust unit tests
+cargo test --workspace
+
+# Python integration tests (CLI, Python API, runtime behavior, etc.)
+uv run pytest
+```
+
+Test coverage includes:
+
+- CLI help output, argument validation, full build/inspect/verify flow
+- Python API functional + object-oriented dual interfaces
+- Encoding detection and unsupported encoding rejection
+- Typed exception mapping
+- UAC manifest writing
+- Native Windows version resource writing
+- Runtime `%~dp0` behavior and working directory preservation
+- Hidden window exit codes
+- Temp file cleanup and forced termination cleanup
+- Python 3.10 syntax compatibility checks
+
+
+## Current Stage & Known Limitations
+
+Bat2PE is ready for **single-script, launcher-style batch projects**. The `build → inspect → verify` workflow is fully operational.
+
+
+| Item | Status |
+|------|--------|
+| Single `.bat` / `.cmd` script conversion | ✅ Fully supported |
+| Icon & version metadata | ✅ Written to native Windows PE resources |
+| UAC admin elevation | ✅ Supported |
+| Hidden window mode | ✅ Supported |
+| Multi-encoding auto-detection | ✅ UTF-8 / UTF-8 BOM / UTF-16 LE BOM / ANSI/GBK |
+
+
+## License
+
+This project is licensed under the [MPL-2.0](LICENSE) license.
+