Skip to main content

🐧 py-pmp-manip

A modular python tool for creating, editing and inspecting Penguinmod(.pmp) and Scratch(.sb3) project files.


🚀 Features

  • Loading and Creating Projects
  • Editing Projects
  • Inspecting Projects

For a documentation overview and a broader usage tutorial, see docs/index.md


📦 Installation

pip install py-pmp-manip

Or clone directly. Do not forget to include submodules:

git clone --recurse-submodules https://github.com/GermanCodeEngineer/py-pmp-manip
cd py-pmp-manip
pip install -e .

Then install Node.js >=18 (this project uses JavaScript for some features):

# Using winget (installs latest LTS)
winget install OpenJS.NodeJS.LTS

# Or using Chocolatey
choco install nodejs-lts

# Verify version
node --version

Or install manually from nodejs.org (choose LTS version).

🧰 Basic Usage

Before using most parts of pmp_manip, you must initialize the configuration once:

from pmp_manip import init_config, get_default_config

# Start from defaults and override what you need
cfg = get_default_config()
cfg.ext_info_gen.gen_opcode_info_dir = "output/gen_opcode_info"
init_config(cfg)

References


📁 Project Structure

py-pmp-manip/
├── pmp_manip/              # Source Code
│   ├── config/             # Configuration schema and lifecycle
│   ├── core/               # Core functionality
│   ├── ext_info_gen/       # Information generator for custom extensions
│   ├── important_consts.py # Common important constants
│   ├── opcode_info/        # Contains an API for and the information about all the blocks
│   │   ├── api/                 # Theoretical structure of the API
│   │   ├── data/                # Actual data for the API
│   │   └── doc_api/             # A seperate API, which gives information about blocks and monitors in a human-readable way 
│   ├── builtin_extension_source/ # Resource Submodule: Adapted Built-in PenguinMod Extensions
│   └── utility/            # Utilities for other modules
├── docs/              # Documentation
├── scripts/           # Independent project-related scripts for developers
│   ├── check_dependency_updates.py # Checks for updates of dependencies
│   ├── check_source_updates.py        # Checks for updates in foreign code files, from which e.g. constants are derived
│   ├── make_uml.py                 # Generates a UML-Diagram for Second Representation
│   └── review_pyproject_toml.py    # Reviews pyproject.toml with version and dependencies
└── tests/             # Unit tests

🧪 Running Tests

Just run:

pytest tests/

📄 License

GPLv3


🤝 Contributing

Pull requests, issues, and feedback are welcome! Please read the CONTRIBUTING.md guide before submitting code.


Metadata

Release files for py-pmp-manip 1.2.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for py-pmp-manip 1.2.6
File Size Uploaded Provenance Actions
py_pmp_manip-1.2.6.tar.gz 521.7 kB Without provenance Details for py_pmp_manip-1.2.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for py-pmp-manip 1.2.6
File Interpreter ABI Platform Actions
py_pmp_manip-1.2.6-py3-none-any.whl Python 3 none any Details for py_pmp_manip-1.2.6-py3-none-any.whl

Total release size: 1.1 MB

Release files / py_pmp_manip-1.2.6.tar.gz

Download URL py_pmp_manip-1.2.6.tar.gz
Size 521.7 kB
Tags Source
SHA-256 checksum
How to use checksums
7026d43c594cf280c24b0086d33b91b1847fa01d6dab626702b3133500a02a11
BLAKE2b-256 checksum
How to use checksums
6eac08f008bba6995d8ab90137cac1f17c1e49f4ffd935efe86bb6d6daff8e48
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.4

Release files / py_pmp_manip-1.2.6-py3-none-any.whl

Download URL py_pmp_manip-1.2.6-py3-none-any.whl
Size 599.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
70c0f494de918e7857d55383b1a2bad5a7a47670942833dc422993c11378e871
BLAKE2b-256 checksum
How to use checksums
c63b43ca6f8b9997457fea3f1c0f4aa0e296eff4e8ed69fc9c3df1ae5bafc29c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.4

Security for py-pmp-manip 1.2.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page