plcopener 0.1.0

Tools for extracting and inserting Structured Text in PLCOpen XML files

PLCOpener Tools

PLCOpener is a professional Python package for extracting and inserting Structured Text (ST) code in PLCOpen XML files (compatible with CODESYS, TwinCAT, etc.).

It allows developers to bridge the gap between monolithic XML exports and modern software engineering practices like Git version control, external code analysis, and automated refactoring.

Features

• Folder Reconstruction: Rebuilds the project tree structure on your filesystem.
• Resource Management: Automatically detects and groups files by PLC applications/resources.
• Resilient Parsing: Robust handling of malformed or incomplete XML project files.
• CLI & Library: Full support for both command-line automation and programmatic use.

Installation

pip install .

Quick Start

1. Extracting ST code

plcopen-extract project.xml -o my_workspace

2. Modifying and Re-inserting

After editing the .st files in my_workspace, push the changes back:

plcopen-insert project.xml --st-dir my_workspace -o updated_project.xml

Documentation

For a detailed project description and complete examples, please see DESCRIPTION.md.

Usage Example (Library)

from plcopener import ProjectExtractor, ProjectInserter

# Extract
ProjectExtractor("project.xml").extract("st_output")

# Insert
ProjectInserter("project.xml").insert("st_output", output_path="updated.xml")