PyMemoryEditor 1.6.0__tar.gz → 2.0.0__tar.gz

pymemoryeditor-2.0.0/.flake8

@@ -0,0 +1,12 @@
+[flake8]
+
+max-line-length = 130
+# E203: whitespace before ':' (black-compatible — black puts spaces around the
+#       colon in slices like data[i : i + n], which conflicts with PEP 8).
+# E701: multiple statements on one line (colon) — used pervasively as a style choice.
+# W503: line break before binary operator (black-compatible).
+ignore = E203, E701, W503
+
+per-file-ignores =
+    # __init__.py files are allowed to have unused imports and lines-too-long.
+    */__init__.py:F401, E501

pymemoryeditor-2.0.0/.gitignore

@@ -0,0 +1,83 @@
+# Byte-compiled / cached
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Build / packaging
+build/
+.build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+*.whl
+*.tar.gz
+pip-log.txt
+pip-delete-this-directory.txt
+MANIFEST
+
+# Virtual environments
+venv/
+.venv/
+env/
+ENV/
+
+# Testing & coverage
+.pytest_cache/
+*.pytest_cache
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+*.cover
+.tox/
+.nox/
+.hypothesis/
+
+# Type checkers & linters
+.mypy_cache/
+.ruff_cache/
+.pyre/
+.pytype/
+
+# IDEs / editors
+.idea/
+.vscode/
+*.code-workspace
+*.sublime-*
+.spyderproject
+.spyproject
+
+# Editor swap / backup files
+*.swp
+*.swo
+*~
+.\#*
+\#*\#
+
+# OS-specific cruft
+.DS_Store
+.AppleDouble
+.LSOverride
+Thumbs.db
+Desktop.ini
+.directory
+
+# Toolchain / version pinning state
+.tool-versions
+.python-version
+
+# Local environment files (never commit secrets)
+.env
+.env.local
+.env.*.local
+
+# Logs / temporary
+*.log
+*.tmp
+
+# Sphinx / docs build output
+docs/_build/
+
+# Project-local
+.claude/

pymemoryeditor-2.0.0/.readthedocs.yaml

@@ -0,0 +1,24 @@
+# Read the Docs configuration file for Sphinx + MyST.
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+formats:
+  - htmlzip
+  - pdf
+  - epub
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

pymemoryeditor-2.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

pymemoryeditor-2.0.0/CONTRIBUTING.md

@@ -0,0 +1,98 @@
+# Contributing to PyMemoryEditor
+
+Thanks for your interest in contributing!
+
+## Development setup
+
+```bash
+python -m venv venv
+source venv/bin/activate    # On Windows: venv\Scripts\activate
+make install-dev            # pip install -e ".[dev]"
+```
+
+The `dev` extra installs the full toolchain and the GUI deps.
+
+The `Makefile` is the single source of truth for the dev commands below — run
+`make help` to see every target (docs, build, coverage, etc.). The raw command
+each target wraps is shown in parentheses if you'd rather run it directly.
+
+## Running the test suite
+
+The tests read and write the memory of the test process itself; they should run
+on any supported platform without elevated privileges.
+
+```bash
+make test                   # pytest tests -v
+```
+
+## Linting
+
+```bash
+make lint                   # flake8 PyMemoryEditor tests
+```
+
+## Type checking
+
+```bash
+make type-check             # mypy PyMemoryEditor
+```
+
+## Before you push
+
+Run lint, type-check and the test suite in one go:
+
+```bash
+make pre-commit             # lint + type-check + test
+```
+
+The CI pipeline runs the same lint, mypy and tests, and blocks merges on failure.
+The test matrix runs on Ubuntu, Windows and macOS across multiple Python versions, so
+all three platform backends are exercised on every push. A dedicated job also
+runs the suite with the `speed` extra (NumPy) to keep the vectorized scan path
+covered. Even so, contributors touching a specific backend are encouraged to
+run `pytest tests` locally on that platform before submitting.
+
+## Project layout
+
+```
+PyMemoryEditor/
+├── __init__.py          # Public API + platform dispatch
+├── enums.py             # ScanTypesEnum (cross-platform)
+├── process/             # Abstract base, errors, process info, util
+├── util/                # Cross-platform helpers: scan and type conversion
+├── win32/               # Windows implementation (kernel32, user32)
+├── linux/               # Linux implementation (process_vm_readv/writev, /proc/<pid>/maps)
+├── macos/               # macOS implementation (task_for_pid, mach_vm_*)
+└── app/                 # PySide6 (Qt) demo app exposed as `pymemoryeditor` CLI
+```
+
+The three platform packages implement `AbstractProcess` from `process/abstract.py`.
+The public alias `OpenProcess` is chosen at import time in `__init__.py` based on
+`sys.platform`.
+
+### Platform-specific test notes
+- **Linux**: requires `/proc/sys/kernel/yama/ptrace_scope=0` to attach to processes
+  not descended from the test runner. Self-process tests work without changes.
+- **macOS**: opening another process requires the Python binary to be signed with
+  the `com.apple.security.cs.debugger` entitlement (or SIP off + root). Self-
+  process tests work without changes.
+- **Windows**: no special privileges needed for self-process tests.
+
+## Submitting changes
+
+1. Open an issue first for bug reports or substantial features.
+2. Branch from `main`. Keep commits focused.
+3. Run `make pre-commit` (lint + type-check + tests) locally before pushing.
+4. Open a PR describing the change and how it was tested.
+
+## Reporting bugs
+
+Please include:
+- Operating system and architecture (e.g. Windows 11 x64, Ubuntu 22.04 x64).
+- Python version (`python --version`).
+- A minimal reproducer if possible.
+- For Linux: whether `/proc/sys/kernel/yama/ptrace_scope` is `0` or `1`.
+
+## Security
+
+If you find a security issue, please see [`SECURITY.md`](https://github.com/JeanExtreme002/PyMemoryEditor/blob/main/SECURITY.md). **Do not** report via GitHub issues.

{pymemoryeditor-1.6.0 → pymemoryeditor-2.0.0}/Makefile

@@ -9,6 +9,8 @@ DIST_DIR = dist
 EGG_INFO = $(PACKAGE_NAME).egg-info
 VENV_DIR = venv
 TEST_DIR = tests
+DOCS_DIR = docs
+DOCS_BUILD_DIR = $(DOCS_DIR)/_build/html
 
 # Colors for output
 GREEN = \033[0;32m
@@ -25,12 +27,13 @@ help:
 	@echo "Available targets:"
 	@echo "  $(YELLOW)install$(NC)          - Install package in development mode"
 	@echo "  $(YELLOW)install-deps$(NC)     - Install dependencies"
+	@echo "  $(YELLOW)install-app$(NC)      - Install dependencies to run the PyMemoryEditor App"
+	@echo "  $(YELLOW)run-app$(NC)          - Run the PyMemoryEditor App"
 	@echo "  $(YELLOW)install-dev$(NC)      - Install development dependencies"
 	@echo "  $(YELLOW)test$(NC)             - Run tests"
 	@echo "  $(YELLOW)test-verbose$(NC)     - Run tests with verbose output"
 	@echo "  $(YELLOW)test-coverage$(NC)    - Run tests with coverage report"
 	@echo "  $(YELLOW)lint$(NC)             - Run linter (flake8)"
-	@echo "  $(YELLOW)lint-fix$(NC)         - Run auto-formatter (black)"
 	@echo "  $(YELLOW)type-check$(NC)       - Run type checker (mypy)"
 	@echo "  $(YELLOW)clean$(NC)            - Clean build artifacts"
 	@echo "  $(YELLOW)build$(NC)            - Build package"
@@ -43,7 +46,10 @@ help:
 	@echo "  $(YELLOW)check-deps$(NC)       - Check for outdated dependencies"
 	@echo "  $(YELLOW)update-deps$(NC)      - Update dependencies"
 	@echo "  $(YELLOW)security$(NC)         - Run security audit"
-	@echo "  $(YELLOW)docs$(NC)             - Generate documentation"
+	@echo "  $(YELLOW)install-docs$(NC)     - Install dependencies to build the documentation"
+	@echo "  $(YELLOW)docs$(NC)             - Build the HTML documentation (output: $(DOCS_BUILD_DIR))"
+	@echo "  $(YELLOW)docs-serve$(NC)       - Live-reload docs server at http://127.0.0.1:8000"
+	@echo "  $(YELLOW)docs-clean$(NC)       - Remove the docs build directory"
 	@echo "  $(YELLOW)venv$(NC)             - Create virtual environment"
 	@echo "  $(YELLOW)venv-activate$(NC)    - Show command to activate venv"
 	@echo "  $(YELLOW)all$(NC)              - Run full pipeline (install, lint, test, build)"
@@ -62,24 +68,37 @@ venv-activate:
 	@echo "$(YELLOW)To activate virtual environment run:$(NC)"
 	@echo "source $(VENV_DIR)/bin/activate"
 
-# Install dependencies
+# Install dependencies (uses pyproject.toml — requirements.txt was removed in v2.0)
 .PHONY: install-deps
 install-deps:
-	@echo "$(GREEN)Installing dependencies...$(NC)"
-	$(PIP) install -r requirements.txt
+	@echo "$(GREEN)Installing runtime dependencies...$(NC)"
+	$(PIP) install -e .
 	@echo "$(GREEN)Dependencies installed successfully!$(NC)"
 
+# Install dependencies to run the PyMemoryEditor App (Qt GUI)
+.PHONY: install-app
+install-app:
+	@echo "$(GREEN)Installing PyMemoryEditor App dependencies...$(NC)"
+	$(PIP) install -e ".[app]"
+	@echo "$(GREEN)App dependencies installed successfully!$(NC)"
+	@echo "$(YELLOW)Launch the app with: pymemoryeditor$(NC)"
+
+# Run the PyMemoryEditor App (Qt GUI)
+.PHONY: run-app
+run-app:
+	@echo "$(GREEN)Starting PyMemoryEditor App...$(NC)"
+	$(PYTHON) -m PyMemoryEditor
+
 # Install development dependencies
 .PHONY: install-dev
 install-dev:
 	@echo "$(GREEN)Installing development dependencies...$(NC)"
-	$(PIP) install -r requirements.txt
-	$(PIP) install pytest pytest-cov flake8 black mypy twine build hatch
+	$(PIP) install -e ".[dev]"
 	@echo "$(GREEN)Development dependencies installed successfully!$(NC)"
 
 # Install package in development mode
 .PHONY: install
-install: install-deps
+install:
 	@echo "$(GREEN)Installing package in development mode...$(NC)"
 	$(PIP) install -e .
 	@echo "$(GREEN)Package installed successfully!$(NC)"
@@ -113,18 +132,11 @@ lint:
 	$(PYTHON) -m flake8 $(PACKAGE_NAME) $(TEST_DIR)
 	@echo "$(GREEN)Linting completed!$(NC)"
 
-# Run auto-formatter
-.PHONY: lint-fix
-lint-fix:
-	@echo "$(GREEN)Running auto-formatter (black)...$(NC)"
-	$(PYTHON) -m black $(PACKAGE_NAME) $(TEST_DIR)
-	@echo "$(GREEN)Code formatting completed!$(NC)"
-
-# Run type checker
+# Run type checker (config in pyproject.toml — ignore_missing_imports is set there)
 .PHONY: type-check
 type-check:
 	@echo "$(GREEN)Running type checker (mypy)...$(NC)"
-	$(PYTHON) -m mypy $(PACKAGE_NAME) --ignore-missing-imports
+	$(PYTHON) -m mypy $(PACKAGE_NAME)
 	@echo "$(GREEN)Type checking completed!$(NC)"
 
 # Clean build artifacts
@@ -204,27 +216,50 @@ check-deps:
 .PHONY: update-deps
 update-deps:
 	@echo "$(GREEN)Updating dependencies...$(NC)"
-	$(PIP) install --upgrade -r requirements.txt
+	$(PIP) install --upgrade -e ".[dev]"
 	@echo "$(GREEN)Dependencies updated!$(NC)"
 
-# Security audit
+# Security audit — uses pip-audit (PyPA-maintained) which works without a
+# paid account, unlike the older `safety` tool.
 .PHONY: security
 security:
-	@echo "$(GREEN)Running security audit...$(NC)"
-	$(PIP) install safety
-	safety check
+	@echo "$(GREEN)Running security audit (pip-audit)...$(NC)"
+	$(PIP) install pip-audit
+	pip-audit
 	@echo "$(GREEN)Security audit completed!$(NC)"
 
-# Generate documentation
+# Install the dependencies needed to build the documentation (Sphinx + MyST +
+# Furo + extensions, listed in docs/requirements.txt). Also installs the
+# package itself in editable mode so autodoc can import it.
+.PHONY: install-docs
+install-docs:
+	@echo "$(GREEN)Installing documentation dependencies...$(NC)"
+	$(PIP) install -r $(DOCS_DIR)/requirements.txt
+	$(PIP) install -e .
+	@echo "$(GREEN)Docs dependencies installed!$(NC)"
+
+# Build the HTML documentation. Output lands in $(DOCS_BUILD_DIR).
 .PHONY: docs
 docs:
-	@echo "$(GREEN)Generating documentation...$(NC)"
-	@if [ -d "docs" ]; then \
-		cd docs && make html; \
-		echo "$(GREEN)Documentation generated in docs/_build/html/$(NC)"; \
-	else \
-		echo "$(YELLOW)No docs directory found. Skipping documentation generation.$(NC)"; \
-	fi
+	@echo "$(GREEN)Building HTML documentation...$(NC)"
+	$(PYTHON) -m sphinx -b html $(DOCS_DIR) $(DOCS_BUILD_DIR)
+	@echo "$(GREEN)Documentation generated at $(DOCS_BUILD_DIR)/index.html$(NC)"
+
+# Live-reload docs server — rebuilds on every save and reloads the browser.
+# Requires `sphinx-autobuild` (installed automatically via install-docs is
+# optional; we install it on demand here for convenience).
+.PHONY: docs-serve
+docs-serve:
+	@echo "$(GREEN)Starting live-reload docs server at http://127.0.0.1:8000$(NC)"
+	@$(PYTHON) -c "import sphinx_autobuild" 2>/dev/null || $(PIP) install sphinx-autobuild
+	$(PYTHON) -m sphinx_autobuild $(DOCS_DIR) $(DOCS_BUILD_DIR) --open-browser
+
+# Wipe the built docs.
+.PHONY: docs-clean
+docs-clean:
+	@echo "$(GREEN)Cleaning docs build directory...$(NC)"
+	rm -rf $(DOCS_DIR)/_build
+	@echo "$(GREEN)Docs build directory removed.$(NC)"
 
 # Full development pipeline
 .PHONY: all
@@ -261,7 +296,7 @@ info:
 	@echo "Pip: $(shell $(PIP) --version)"
 	@echo ""
 	@echo "$(GREEN)Installed packages:$(NC)"
-	@$(PIP) list | grep -E "($(PACKAGE_NAME)|pytest|flake8|black|mypy|twine|build)"
+	@$(PIP) list | grep -E "($(PACKAGE_NAME)|pytest|flake8|mypy|twine|build)"
 
 # Quick release workflow
 .PHONY: release
@@ -291,4 +326,4 @@ install-from-test-pypi:
 uninstall:
 	@echo "$(GREEN)Uninstalling package...$(NC)"
 	$(PIP) uninstall $(PACKAGE_NAME) -y
-	@echo "$(GREEN)Package uninstalled!$(NC)"
+	@echo "$(GREEN)Package uninstalled!$(NC)"