README

A powerful PHP-based data transformation and processing tool designed for handling complex data pipelines, file format conversions, and integration workflows. This tool provides a flexible framework for transforming data between various formats with support for custom actions, directives, and extensible processing pipelines.

Key Features

Multi-format Support: Process CSV, XML, JSON, and other structured data formats
Flexible Transformations: Chain multiple transformation steps with configurable actions
Extensible Architecture: Create custom actions and extensions for specific use cases
Integration Ready: Built-in support for Akeneo PIM and other e-commerce platforms
Debugging Tools: Comprehensive debugging and validation capabilities
Docker Support: Containerized environment for consistent deployments

Quick Start

Installation

bin/docker/composer install

Basic Usage

Transform a file using a transformation configuration:

bin/docker/console transformation --file examples/transformation.yaml --source data/input --workpath data/output

For detailed installation and setup instructions, see the Getting Started Guide.

Documentation

📚 Getting Started

Installation Guide - Step-by-step setup instructions
Quick Start Tutorial - Your first transformation
Configuration Guide - Setting up accounts and contexts

👥 User Guide

Running Transformations - Complete workflow guide
Debugging & Troubleshooting - Solve common issues
CLI Commands - Command-line reference

📖 Reference Documentation

Actions - All available transformation actions
Directives - Configuration directives and options
Converters - Data format converters
Tools - Utility tools and helpers

🔧 Developer Guide

Architecture Overview - System design and components
Creating Extensions - Build custom actions
Contributing - Development guidelines

💡 Examples

Basic Transformations - Common use cases
Advanced Workflows - Complex transformation patterns

Configuration

Account Setup

Add API credentials and account information to your transformation files:

account:
   name: "my-account"
   username: "my-username"
   password: "my-password"
   domain: "my-domain"
   client_id: "my-client-id"
   client_secret: "my-client-secret"

Context Parameters

Define reusable parameters across transformations:

context:
    my-parameter: "my-value"
    environment: "production"

Common Commands

Basic Transformation

bin/docker/console transformation --file path/to/config.yaml --source input/dir --workpath output/dir

Debugging Options

# Debug first item
bin/docker/console transformation --file config.yaml --source input --workpath output --debug

# Test first 100 items
bin/docker/console transformation --file config.yaml --source input --workpath output --try 100

# Show dynamic mappings
bin/docker/console transformation --file config.yaml --source input --workpath output --showMappings

# Process specific line
bin/docker/console transformation --file config.yaml --source input --workpath output --line 100

Help and Options

bin/docker/console transformation --help

Project Structure

├── docs/                    # Documentation
│   ├── getting-started/     # Installation and setup guides
│   ├── user-guide/         # User documentation
│   ├── reference/          # API and component reference
│   ├── developer-guide/    # Technical documentation
│   └── examples/           # Tutorials and examples
├── src/                    # Source code
├── examples/               # Sample projects and data
├── config/                 # Configuration templates
└── tests/                  # Test suites

Support

Documentation: Complete documentation
Examples: Browse the examples directory for real-world use cases
Issues: Report bugs and request features via the project issue tracker

License

This project is licensed under the terms specified in the project license file.

induxx / parsable-file-multi-tool

Maintainers

Details