picklock 0.1.0__tar.gz

picklock-0.1.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

picklock-0.1.0/.gitignore

@@ -0,0 +1,91 @@
+# 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/
+
+# Generated from the command registry at build time by
+# scripts/generate_command_reference.py — committing it would let a
+# stale copy outlive the code it describes.
+docs/reference/commands.md
+
+# Project-local
+.claude/
+
+# A throwaway alias store, if one is pointed here
+aliases.json

picklock-0.1.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
+`contact@jeanloui.dev`.
+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.

picklock-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,210 @@
+# Contributing to Picklock
+
+Thanks for your interest in contributing!
+
+Picklock is a terminal client for [PyMemoryEditor][pyme]. If your change is
+about *how memory is read, written or scanned*, it probably belongs upstream in
+PyMemoryEditor; if it is about *what you type and what you see*, it belongs
+here. When in doubt, open an issue and it will be routed.
+
+## Development setup
+
+```bash
+python -m venv venv
+source venv/bin/activate    # On Windows: venv\Scripts\activate
+make install-dev            # pip install -e ".[dev]"
+```
+
+The `Makefile` is the single source of truth for the dev commands below — run
+`make help` to see every target. The raw command each target wraps is shown in
+parentheses if you would rather run it directly.
+
+## Running the test suite
+
+```bash
+make test                   # pytest tests -v
+```
+
+The suite has two halves.
+
+Most of it never touches a process: parsing, formatting, dispatch, help,
+aliases, settings. Those run in about two seconds.
+
+`tests/test_end_to_end.py` drives every command against a **real** process —
+the test process itself, the same trick PyMemoryEditor's own suite uses, which
+is why it needs no privileges and no second program to launch. It puts known
+values in memory with `ctypes`, types the command, and asserts on the table
+that comes back. What is under test is the command, not the library: a failure
+there means Picklock is wrong.
+
+The scans walk a live address space, so they add about thirty seconds.
+`make test` includes them and CI runs the lot, which is the point: a command
+body is not covered until it has run against a real process. The `target`
+fixture skips itself if the platform refuses to open its own process, so a
+hostile runner degrades to the fast half rather than failing.
+
+## Linting and type checking
+
+```bash
+make lint                   # flake8 picklock tests
+make type-check             # mypy picklock
+```
+
+## Before you push
+
+```bash
+make pre-commit             # lint + type-check + test
+```
+
+CI runs the same three, plus a build, on Ubuntu, Windows and macOS across
+Python 3.10–3.13. The matrix matters here: the shell has to start and dispatch
+identically where `readline` is missing (Windows), and `picklock -e "version"`
+is smoke-tested from the installed console script on every cell.
+
+## Project layout
+
+```
+picklock/
+├── __init__.py        # Version and the public re-exports
+├── __main__.py        # python -m picklock
+├── cli.py             # argparse front end: flags, batch mode, exit statuses
+├── shell.py           # The REPL: line splitting, dispatch, readline, history
+├── session.py         # Everything a session remembers: target, results, settings
+├── addressing.py      # The address expression language ([...], module+offset, #N)
+├── valuetypes.py      # The type vocabulary and the signed/unsigned bridge
+├── output.py          # Every byte Picklock prints: tables, hexdump, footers
+├── processes.py       # Cross-platform process enumeration
+├── store.py           # The JSON files Picklock remembers things in
+├── errors.py          # CommandError and friends
+└── commands/          # One module per group; each registers with @command
+```
+
+Two rules keep the shape:
+
+- **Commands never print directly.** They go through `session.printer`, which
+  is what makes output testable against a `StringIO`.
+- **Anything the user got wrong raises `CommandError`.** The shell catches that
+  one class, prints one `ERROR:` line and returns to the prompt. An exception
+  that is *not* a `CommandError` is a bug in Picklock and is allowed to escape
+  with its traceback.
+
+## Adding a command
+
+1. Pick the module in `picklock/commands/` that matches the namespace.
+2. Register the handler. The name is a colon-separated path whose first
+   segment is one of the groups in `NAMESPACES`; the heading in `help` follows
+   from it, so there is nothing to keep in step. Do **not** give it a
+   plain-word alias: two groups could each want `read`, and a test enforces
+   that namespaced commands have none.
+
+   Note the word *namespace* is internal. To the reader there are only
+   commands, some of which take a subcommand — a test sweeps every help page,
+   topic and error to keep the word out of what they see.
+
+   A name with no colon is a **top-level** command, reserved for the shell's
+   own vocabulary (`help`, `set`, `exit`). Anything that touches the target
+   belongs in a namespace, and a test enforces that too.
+
+   ```python
+   def _mycommand_parser() -> CommandParser:
+       parser = CommandParser("memory:mycommand")
+       parser.add_argument("address", help="what to act on")
+       return parser
+
+
+   @command(
+       "memory:mycommand",
+       parser=_mycommand_parser,
+       summary="One line, sentence case, ending in a period.",
+       details="The long help, printed by 'help memory:mycommand'.",
+       examples=("memory:mycommand 0x1000",),
+   )
+   def cmd_mycommand(session: Session, args: List[str]) -> None:
+       options = _mycommand_parser().parse_args(args)
+
+       process = session.require_process("memory:mycommand")
+       address = parse_address(options.address, session)
+       ...
+   ```
+
+   There is no `usage=`: the usage line is generated from the parser, so it
+   always names every flag the command accepts. Give each argument a `help=`
+   and a readable `metavar` — those two are what the help is built from.
+
+   If the command prints a table that can be longer than a screen, page it
+   with the shared helpers rather than a `--limit` of your own:
+
+   ```python
+   def _mycommand_parser() -> CommandParser:
+       return add_paging_arguments(CommandParser("memory:mycommand"))
+
+
+   page = paginate(
+       session, rows, command="memory:mycommand",
+       limit=options.limit, page=options.page, show_all=options.all,
+   )
+   session.printer.table(headers, page.rows, total=page.total,
+                         page=page.number, pages=page.count,
+                         next_page=page.next_page)
+   ```
+
+   That gives the same three flags, the same wording, the same
+   `page N of M` footer and the same `Next page: ...` line as every other
+   listing — and a test enforces that the wording does not drift.
+
+   Names go **two levels at most** — `scan:keep`, never `scan:results:keep`.
+   The registry rejects a third level, and a test pins that down: a deeper name
+   buys tidiness at the cost of a listing that has to be walked twice to be
+   read once.
+
+   `<command>:help` is a dispatcher convention rather than a registered
+   command, so it answers for every command at every depth — `memory:help`,
+   `memory:read:help`, `clear:help` — without one `help` command per group
+   cluttering the listings it exists to print. It keeps working, but the
+   spelling the help *advertises* is `help <command>`: one form for everything,
+   and it reads as a sentence.
+
+3. Use `CommandParser`, not a bare `ArgumentParser`: it raises instead of
+   calling `sys.exit`, which would kill the shell on a typo.
+4. Take addresses through `parse_address` so your command speaks the same
+   `[game.exe+0x10]+0x8` and `#3` language as every other one.
+
+Pass every argument a `help=` string. `help <command>` (and `<command> --help`)
+builds its **Arguments** and **Options** sections from the parser itself, so
+the documentation cannot drift from what the command accepts — there is only
+one definition of either.
+
+`help` and `picklock --help` are likewise generated from the registry, so a
+command cannot be added without also being documented. `tests/test_commands.py`
+enforces all of it: every command must declare a parser, every argument must
+carry help text, every flag must appear in the command's help, and a usage line
+may not advertise a flag the parser does not accept. A new command is covered
+the moment it is registered.
+
+## 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` locally before pushing.
+4. PR titles follow [Conventional Commits][cc] (`feat:`, `fix:`, `docs:`, …) —
+   CI lints the title.
+5. Describe the change and how it was tested. For a command body, paste the
+   session.
+
+## Reporting bugs
+
+Please include:
+
+- The output of `picklock --version` — it names Picklock, PyMemoryEditor,
+  Python and the platform.
+- The exact command you typed and the exact output you got.
+- Whether you were running elevated (`sudo` / Administrator).
+- 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/Picklock/blob/main/SECURITY.md).
+**Do not** report it via GitHub issues.
+
+[pyme]: https://github.com/JeanExtreme002/PyMemoryEditor
+[cc]: https://www.conventionalcommits.org/

picklock-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jean Loui Bernard Silva de Jesus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.