PyMemoryEditor 3.0.0__tar.gz → 3.0.2__tar.gz

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/Makefile

@@ -229,7 +229,7 @@ security:
 	@echo "$(GREEN)Security audit completed!$(NC)"
 
 # Install the dependencies needed to build the documentation (Sphinx + MyST +
-# Furo + extensions, listed in docs/requirements.txt). Also installs the
+# the Read the Docs theme + extensions, listed in docs/requirements.txt). Also installs the
 # package itself in editable mode so autodoc can import it.
 .PHONY: install-docs
 install-docs:

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: PyMemoryEditor
-Version: 3.0.0
+Version: 3.0.2
 Summary: Read, write and scan process memory in a few lines of Python — Cheat Engine-style scans, pointer chains and AOB search on Windows, Linux and macOS.
 Project-URL: Homepage, https://github.com/JeanExtreme002/PyMemoryEditor
 Project-URL: Documentation, https://pymemoryeditor.readthedocs.io
@@ -61,6 +61,8 @@ Description-Content-Type: text/markdown
 
 # PyMemoryEditor
 
+<!-- mcp-name: io.github.JeanExtreme002/PyMemoryEditor -->
+
 A pure-Python library (built on [ctypes](https://docs.python.org/3/library/ctypes.html)) that lets you **inspect, modify and search the memory of any running process in a few lines of Python** — Cheat Engine workflows on Windows, Linux and macOS!
 
 ---

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/PyMemoryEditor/__init__.py

@@ -8,7 +8,7 @@ Supported platforms: Windows, Linux and macOS (32-bit and 64-bit).
 """
 
 __author__ = "Jean Loui Bernard Silva de Jesus"
-__version__ = "3.0.0"
+__version__ = "3.0.2"
 
 import logging
 import sys

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/PyMemoryEditor/app/application.py

@@ -559,7 +559,20 @@ def main_cli(argv=None):
 
     Kept separate from :func:`main` so that process-wide change only happens
     when the app *is* the process, never when it is embedded in someone else's.
+
+    ``pymemoryeditor mcp [flags]`` runs the MCP server instead, the same as
+    ``pymemoryeditor-mcp [flags]``. MCP registries launch a PyPI package by its
+    project name (``uvx --from "PyMemoryEditor[mcp]" pymemoryeditor mcp``), so
+    this is the only command they can reach. It never touches Qt, and the
+    server keeps its own signal handling.
     """
+    if argv is None:
+        argv = sys.argv
+    if len(argv) > 1 and argv[1].strip() == "mcp":
+        from PyMemoryEditor.mcp.server import main as mcp_main
+
+        return mcp_main(argv[2:])
+
     with _scoped_signal_handler(signal.SIGINT, signal.SIG_DFL):
         return main(argv)
 

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/README.md

@@ -1,5 +1,7 @@
 # PyMemoryEditor
 
+<!-- mcp-name: io.github.JeanExtreme002/PyMemoryEditor -->
+
 A pure-Python library (built on [ctypes](https://docs.python.org/3/library/ctypes.html)) that lets you **inspect, modify and search the memory of any running process in a few lines of Python** — Cheat Engine workflows on Windows, Linux and macOS!
 
 ---

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/docs/api/index.md

@@ -1,7 +1,8 @@
 # API Reference
 
 Every public class, method and helper PyMemoryEditor exposes. For
-task-oriented walkthroughs, see the [User Guide](../guide/index.md).
+task-oriented walkthroughs, start at
+[Opening a process](../guide/opening-process.md).
 
 ## At a glance
 
@@ -20,14 +21,27 @@ task-oriented walkthroughs, see the [User Guide](../guide/index.md).
 
 ```{toctree}
 :maxdepth: 1
+:caption: The Entry Point
 
 openprocess
 enums
+```
+
+```{toctree}
+:maxdepth: 1
+:caption: Objects You Get Back
+
 memory-region
 remote-pointer
 pointer-path
 module-info
 thread-info
+```
+
+```{toctree}
+:maxdepth: 1
+:caption: Errors and Helpers
+
 errors
 utilities
 ```

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/docs/conf.py

@@ -23,7 +23,7 @@ copyright = f"{datetime.now().year}, {author}"
 try:
     from PyMemoryEditor import __version__ as release
 except Exception:  # pragma: no cover - docs can build without the package installed
-    release = "2.0.0"
+    release = "3.0.2"
 
 version = ".".join(release.split(".")[:2])
 

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/docs/index.md

@@ -31,7 +31,8 @@ scans, freezing values) to a small, friendly API that works **identically on
 Windows, Linux and macOS**.
 
 Get going with the [Installation](installation.md) and [Quick Start](quickstart.md)
-pages, then dig into the [User Guide](guide/index.md) for the in-depth walkthroughs.
+pages, then work through the guide itself, starting at
+[Opening a process](guide/opening-process.md).
 Prefer to click rather than type? The bundled [GUI app](app.md) gives you a
 Cheat Engine-style interface for free.
 
@@ -100,48 +101,87 @@ explore, scan and freeze values by clicking.
 </tr>
 </table>
 
-## User's Guide
+## Documentation
 
-This part of the documentation walks you through every workflow, from opening a
-process to following multi-level pointer chains, plus the bundled GUI app.
+Every workflow is covered, from opening a process to following multi-level
+pointer chains — plus the bundled GUI app, the MCP server for AI assistants,
+and the reference for every public symbol. Each group below stands on its own,
+so you can start wherever your question is.
 
 ```{toctree}
-:maxdepth: 2
+:maxdepth: 1
+:caption: Getting Started
 
 why
 installation
 quickstart
-guide/index
-app
-mcp
 ```
 
-## API Reference
+```{toctree}
+:maxdepth: 1
+:caption: Core Workflow
 
-If you are looking for information on a specific class, method or parameter,
-this part of the documentation is for you.
+guide/opening-process
+guide/read-write
+guide/searching
+guide/pattern-scan
+```
 
 ```{toctree}
-:maxdepth: 2
+:maxdepth: 1
+:caption: Inspecting the Process
 
-api/index
+guide/memory-regions
+guide/modules-threads
+```
+
+```{toctree}
+:maxdepth: 1
+:caption: Pointers
+
+guide/pointers
+guide/pointer-scan
+```
+
+```{toctree}
+:maxdepth: 1
+:caption: Memory Allocation
+
+guide/allocate-free
 ```
 
-## Additional Notes
+```{toctree}
+:maxdepth: 1
+:caption: Tools
 
-Platform-specific behaviour, troubleshooting, logging, a glossary of the terms
-used throughout these docs, plus how to contribute and the project's license.
+app
+mcp
+```
+
+```{toctree}
+:maxdepth: 2
+:caption: API Reference
+
+api/index
+```
 
 ```{toctree}
 :maxdepth: 1
+:caption: Additional Notes
 
 platform-notes
 troubleshooting
 guide/logging
+glossary
+```
+
+```{toctree}
+:maxdepth: 1
+:caption: Project
+
 contributing
 funding
 license
-glossary
 ```
 
 ## Project links

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/docs/installation.md

@@ -18,7 +18,7 @@ any platform.
 pip install PyMemoryEditor
 ```
 
-## Install with the bundled GUI app
+## 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:

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/docs/mcp.md

@@ -85,6 +85,9 @@ pymemoryeditor-mcp --allow-process game.exe   # never asks for game.exe
 pymemoryeditor-mcp --allow-any-process        # never asks at all (scripts/CI)
 ```
 
+`pymemoryeditor mcp` is the same command, flags included: it is how clients
+that install from the MCP Registry start the server.
+
 ## Flags
 
 <table>

{pymemoryeditor-3.0.0 → pymemoryeditor-3.0.2}/pyproject.toml

@@ -166,6 +166,7 @@ exclude = [
     "/.coveragerc-lib",
     "/.coveragerc-mcp",
     "/scripts",
+    "/server.json",
 ]
 
 # hatchling>=1.27 is required for PEP 639 metadata: the SPDX ``license = "MIT"``

pymemoryeditor-3.0.2/tests/mcp_server/test_registry.py

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+
+"""
+The MCP Registry listing (server.json) and the command it makes clients run.
+
+A registry client starts a PyPI server as ``uvx <runtime args> <identifier>
+<package args>``, with the identifier being the PyPI project. So the listing
+only works while four things agree: the server name in server.json and the
+``mcp-name`` marker in the README that PyPI shows (the registry's ownership
+check), the versions in server.json and the package, and the console script
+the identifier names, which must start the server when given ``mcp``.
+"""
+
+import json
+import re
+import sys
+from pathlib import Path
+
+import pytest
+
+import PyMemoryEditor
+
+ROOT = Path(__file__).resolve().parents[2]
+
+
+@pytest.fixture(scope="module")
+def server():
+    return json.loads((ROOT / "server.json").read_text(encoding="utf-8"))
+
+
+@pytest.fixture(scope="module")
+def package(server):
+    (package,) = server["packages"]
+    return package
+
+
+def test_readme_carries_the_registry_name(server):
+    readme = (ROOT / "README.md").read_text(encoding="utf-8")
+
+    assert re.findall(r"mcp-name: (\S+) -->", readme) == [server["name"]]
+
+
+def test_versions_follow_the_package(server, package):
+    version = PyMemoryEditor.__version__
+
+    assert server["version"] == package["version"] == version
+    assert {"type": "named", "name": "--from"}.items() <= package["runtimeArguments"][0].items()
+    assert package["runtimeArguments"][0]["value"] == "PyMemoryEditor[mcp]==" + version
+
+
+def test_the_command_a_client_builds_starts_the_server(package):
+    pyproject = (ROOT / "pyproject.toml").read_text(encoding="utf-8")
+    scripts = re.search(r"\[project\.scripts\](.*?)\n\[", pyproject, re.S).group(1)
+
+    # uvx looks the executable up by its exact name, and the console scripts
+    # are lowercase: "PyMemoryEditor" would not be found on Linux.
+    assert re.search(r'^{} = "PyMemoryEditor\.app\.application:main_cli"$'.format(package["identifier"]), scripts, re.M)
+    assert package["runtimeHint"] == "uvx"
+    assert package["packageArguments"] == [{"type": "positional", "value": "mcp"}]
+    assert package["transport"] == {"type": "stdio"}
+
+
+def test_description_fits_the_registry_limit(server):
+    # The registry rejects a description over 100 characters at publish time.
+    assert len(server["description"]) <= 100
+
+
+def test_mcp_subcommand_runs_the_server_without_qt(monkeypatch):
+    from PyMemoryEditor.app import application
+    from PyMemoryEditor.mcp import server as mcp_server
+
+    received = []
+    monkeypatch.setattr(mcp_server, "main", lambda argv: received.append(list(argv)) or 0)
+    monkeypatch.setattr(application, "main", lambda argv: pytest.fail("the Qt app started"))
+    monkeypatch.setitem(sys.modules, "PySide6", None)  # any Qt import would raise
+
+    assert application.main_cli(["pymemoryeditor", "mcp", "--read-only", "--allow-process", "game.exe"]) == 0
+    assert received == [["--read-only", "--allow-process", "game.exe"]]
+
+
+def test_other_arguments_still_reach_the_app(monkeypatch):
+    from PyMemoryEditor.app import application
+
+    received = []
+    monkeypatch.setattr(application, "main", lambda argv: received.append(argv))
+
+    application.main_cli(["pymemoryeditor", "--version"])
+    assert received == [["pymemoryeditor", "--version"]]

pymemoryeditor-3.0.0/docs/guide/index.md

@@ -1,53 +0,0 @@
-# User Guide
-
-Task-oriented walkthroughs of every PyMemoryEditor workflow, from opening a
-process to following multi-level pointer chains. Each page is self-contained
-and cross-links to the relevant [API reference](../api/index.md).
-
-New here? Read the [Quick Start](../quickstart.md) first, then come back for
-the in-depth version.
-
-## What's covered
-
-- **Core workflow** — open a process, read/write values, and find addresses by
-  value or byte pattern. This is the classic Cheat Engine loop.
-- **Inspecting the process** — enumerate memory regions, loaded modules and
-  threads.
-- **Pointers** — walk pointer chains you know, and reverse-scan to discover the
-  chains that survive a restart.
-- **Advanced** — reserve and release memory inside the target.
-
-For diagnostics, see [Logging](logging.md) in the Reference section.
-
-```{toctree}
-:caption: Core workflow
-:maxdepth: 1
-
-opening-process
-read-write
-searching
-pattern-scan
-```
-
-```{toctree}
-:caption: Inspecting the process
-:maxdepth: 1
-
-memory-regions
-modules-threads
-```
-
-```{toctree}
-:caption: Pointers
-:maxdepth: 1
-
-pointers
-pointer-scan
-```
-
-```{toctree}
-:caption: Advanced
-:maxdepth: 1
-
-allocate-free
-```