Skip to content

Latest commit

 

History

History
92 lines (65 loc) · 2.43 KB

File metadata and controls

92 lines (65 loc) · 2.43 KB

Installation

PyMemoryEditor is published on PyPI as a pure-Python wheel — there is no native build step or compiler required on any platform.

Requirements

Python3.10 or newer
Operating systems🪟 Windows · 🐧 Linux · 🍎 macOS (32-bit and 64-bit)
Runtime dependencypsutil (installed automatically)

Install the library

pip install PyMemoryEditor

Install with the bundled GUI app

The library ships an optional Cheat Engine-style GUI built on PySide6 (Qt for Python). To install it, use the app extra:

pip install "PyMemoryEditor[app]"

Once installed, launch the app from any terminal:

pymemoryeditor

The library itself stays dependency-free — only the app extra pulls PySide6 in.

See the GUI App guide for a tour of every feature.

Install from source

git clone https://github.com/JeanExtreme002/PyMemoryEditor.git
cd PyMemoryEditor
pip install -e ".[dev]"

The dev extra installs the test toolchain (pytest, pytest-xdist, pytest-qt, hypothesis, mypy, etc.) — see CONTRIBUTING.md for the development workflow.

Verifying the installation

import PyMemoryEditor
print(PyMemoryEditor.__version__)

If that prints a version number, you're ready to go — head to the Quick Start.

Platform-specific notes

:class: note

Works out of the box. To attach to **protected processes** (system services,
elevated apps), run your terminal **as Administrator**.
:class: note

Access depends on `ptrace_scope` and process ownership. If the target is **not**
a child of the caller and `ptrace_scope=1` (the common default), you'll see a
`PermissionError`. Run as root, or relax it:

    sudo sysctl kernel.yama.ptrace_scope=0
:class: note

Opening **another** process requires the Python binary to be signed with the
`com.apple.security.cs.debugger` entitlement (or SIP disabled and root).
**Opening the current process** always works — handy for self-inspection and
experimentation.

For the long version, see Platform Notes.