py-pmp-manip 1.0.1

Python tool for creating, editing and inspecting Penguinmod(.pmp) and Scratch(.sb3) files.

🐧 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:

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

🧰 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

• For more config details, see docs/config.md
• For a documentation overview and a broader usage tutorial, see docs/index.md

---

📁 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
│   ├── opcode_info/             # Contains an API for and the information about all the blocks
│   ├── utility/                 # Utilities for other modules
│   └── important_consts.py      # Common important constants
├── docs/              # Documentation
├── scripts/           # Independent project-related scripts
│   └── update_pyproject_toml.py # Updates 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.

---