idavenv 0.1.0__tar.gz

idavenv-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }}, ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run tests
+        run: uv run pytest -v --tb=short
+
+      - name: Build package (smoke test)
+        run: uv build

idavenv-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,107 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  # ── 1. 跨平台测试门禁 ──
+  test:
+    name: Test (Python ${{ matrix.python-version }}, ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run tests
+        run: uv run pytest -v --tb=short
+
+  # ── 2. 构建分发包 ──
+  build:
+    name: Build distribution
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  # ── 3. 发布到 PyPI (Trusted Publisher) ──
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  # ── 4. 创建 GitHub Release ──
+  github-release:
+    name: Create GitHub Release
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

idavenv-0.1.0/.gitignore

@@ -0,0 +1,233 @@
+__pycache__/
+*.pyc
+.pytest_cache/
+.coverage
+htmlcov/
+dist/
+build/
+*.egg-info/
+.venv/
+env/
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+.ai_memory/

idavenv-0.1.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.5
+Name: idavenv
+Version: 0.1.0
+Summary: Cross-platform automated IDAPython virtual environment management powered by uv
+Project-URL: Repository, https://github.com/ckcat/idavenv
+Author: ckcat
+License: MIT
+License-File: LICENSE
+Keywords: binary-analysis,ida,idapro,idapython,reverse-engineering,security,uv,venv,virtualenv
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# idavenv 🚀
+
+[![PyPI](https://img.shields.io/pypi/v/idavenv.svg)](https://pypi.org/project/idavenv/)
+[![Python](https://img.shields.io/badge/Python-3.8%2B-blue.svg)](https://www.python.org/)
+[![Backend](https://img.shields.io/badge/Powered%20by-uv-purple.svg)](https://github.com/astral-sh/uv)
+[![Platform](https://img.shields.io/badge/Platform-Windows%20%7C%20macOS%20%7C%20Linux-green.svg)]()
+[![License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE)
+
+基于 **`uv`** 的跨平台自动化 **IDAPython 虚拟环境** 管理工具与 Python 库。
+
+参考 Hex-Rays 官方社区讨论 [Using a virtualenv for IDAPython](https://community.hex-rays.com/t/using-a-virtualenv-for-idapython/261/9)，通过非侵入式的 `idapythonrc.py` 智能 Hook 机制，使 IDA Pro 能够无缝、自动加载独立的 Python 虚拟环境及其第三方依赖（如 `z3-solver`, `requests`, `capstone`, `ida-pro-mcp` 等）。
+
+---
+
+## 🌟 核心特性
+
+- ⚡ **毫秒级极速管理**：深度集成 Astral 的 **`uv`**（`uv venv` 和 `uv pip`），秒级创建环境与解析依赖，同时提供标准库 `venv` 的无缝回退支持。
+- 🖥️ **全平台深度适配**：
+  - **Windows**：自动探测 `%APPDATA%\Hex-Rays\IDA Pro` 与 `Lib/site-packages`，原生支持 Python 3.8+ `os.add_dll_directory`（解决 `z3`, `unicorn`, `keystone` 等二进制扩展 DLL 动态加载问题）。
+  - **Linux**：自动探测 `~/.idapro` 与 `lib/pythonX.Y/site-packages`。
+  - **macOS**：自动探测 `~/.idapro`。
+  - 支持 `$IDAUSR` 多路径智能发现（优先复用已有配置）。
+- 🛡️ **智能非侵入式 Hook**：
+  - 使用专用标记块 (`# >>> IDAPython Virtualenv Hook >>>`) 注入 `idapythonrc.py`，绝不破坏用户原有的 IDA 配置。
+  - 自动提升虚拟环境在 `sys.path` 中的加载优先级，彻底防止宿主全局旧版本包覆盖（Shadowing）。
+  - 内置 `builtins` 哨兵变量机制，杜绝在 IDA 中切换数据库或重复执行时的重入副作用。
+  - 包含 Python 版本不匹配智能诊断与友好告警。
+- 🔄 **动态多环境切换**：
+  - 支持通过环境变量 `IDAPYTHON_VENV=/path/to/custom_venv` 动态临时覆盖当前激活的虚拟环境。
+- 📦 **支持多种依赖安装格式**：
+  - 支持安装单个/多个包：`idavenv install z3-solver requests`
+  - 支持批量安装依赖文件：`idavenv install -r requirements.txt`
+  - 支持安装 GitHub 仓库：`idavenv install "git+https://github.com/mrexodia/ida-pro-mcp"`
+
+---
+
+## 🚀 极速上手
+
+### 方式 1：使用 `uvx` 免安装直接运行（最优雅推荐！）
+
+无需提前安装任何包，直接在终端中调用：
+
+```bash
+# 1. 一键初始化 IDAPython 虚拟环境并自动关联 IDA
+uvx idavenv init
+
+# 2. 为 IDA 安装依赖（秒级解析安装）
+uvx idavenv install z3-solver requests
+
+# 3. 诊断当前环境状态
+uvx idavenv info
+```
+
+---
+
+### 方式 2：使用 `pip` 或 `pipx` 全局安装
+
+```bash
+pip install idavenv
+
+# 随后可在任意终端直接使用 idavenv 命令：
+idavenv init
+idavenv install z3-solver
+idavenv info
+```
+
+---
+
+### 方式 3：源码本地运行
+
+```bash
+uv run main.py init
+uv run main.py install z3-solver
+uv run main.py info
+```
+
+---
+
+## 🛠️ 命令行参考 (CLI Reference)
+
+```
+usage: idavenv [-h] [--version] {init,info,install,list,run,uninstall} ...
+
+positional arguments:
+  init                Create virtualenv and link to IDA via idapythonrc.py
+  info                Display IDA and IDAPython virtualenv status.
+  install             Install Python packages or requirement files into IDAPython virtualenv.
+  list                List packages installed in IDAPython virtualenv.
+  run                 Run a command inside IDAPython virtualenv environment.
+  uninstall           Remove IDAPython virtualenv hook and optionally delete venv.
+```
+
+### 常用命令示例
+
+```bash
+# 1. 初始化并指定特定 Python 解释器 (例如 3.11)
+idavenv init --python 3.11
+
+# 2. 安装 requirements.txt 文件中的所有依赖
+idavenv install -r requirements.txt
+
+# 3. 查看环境中已安装的依赖
+idavenv list
+
+# 4. 在虚拟环境中执行测试命令
+idavenv run python -c "import z3; print(z3.__version__)"
+
+# 5. 解除 IDA 关联
+idavenv uninstall
+```
+
+---
+
+## 💻 Python API 使用
+
+作为第三方库被其它 IDA 插件或自动化工具集成：
+
+```python
+from idavenv import IDAVirtualenvManager
+
+manager = IDAVirtualenvManager()
+
+# 初始化环境并关联 IDA
+manager.init()
+
+# 安装依赖
+manager.install_packages(packages=["z3-solver", "requests"])
+
+# 查看状态
+status = manager.status()
+print(f"Hook installed: {status.is_hooked}")
+print(f"Venv path: {status.venv_dir}")
+```
+
+---
+
+## 📦 PyPI 构建与发布指南
+
+### 构建分发包
+
+```bash
+uv build
+# 产物生成在 dist/ 目录下：
+# - dist/idavenv-0.1.0.tar.gz (sdist)
+# - dist/idavenv-0.1.0-py3-none-any.whl (wheel)
+```
+
+### 发布到 PyPI
+
+```bash
+# 使用 uv publish 上传
+uv publish
+# 或通过 API Token 发布
+uv publish --token <YOUR_PYPI_API_TOKEN>
+```
+
+---
+
+## 🧪 自动化测试
+
+项目遵循严格的 TDD 规范，覆盖全部跨平台路径、Hook 注入、DLL 目录、版本诊断与 CLI 功能（41 项测试全部通过）：
+
+```bash
+uv run pytest -v
+```
+
+---
+
+## 📄 License
+
+MIT License.