frameworkapi 0.0.5.3

Python module to easily run scripts in modular frameworks Written by pedrohenriquecoimbra

FrameworkAPI, a Modular Framework Runner

A Python module for creating fully modular and extensible workflows by combining scripts in different languages, managing YAML-based configurations, and offering an API for seamless integration.

---

Features

🚀 Script Runner

Easily run scripts written in Python, R, or Julia with dynamic argument support.

• Automatic Language Detection: Identify script type and invoke the appropriate runtime (e.g., python, Rscript, julia).
• Flexible Argument Passing: Pass command-line arguments directly to scripts for parameterized execution.
• Robust Error Handling: Logs and handles errors during script execution.

📜 YAML Configuration Handler

Effortlessly parse, validate, and manage YAML files with cross-references.

• Dynamic Parsing: Load YAML configurations into Python objects.
• Cross-Reference Resolution: Automatically resolve dependencies between keys within a single file or across multiple files.
• Flexible Configuration Management: Merge or extend YAML files to build modular workflows.

🛠 High-Level API for Script Execution

A simple API to link scripts and configurations for easy execution.

• Script Discovery: Fetch script paths and parameters from the YAML configuration.
• Workflow Automation: Execute scripts dynamically based on configuration settings.
• Extensibility: Add hooks for pre- and post-processing or extend functionality as needed.

---

Installation

pip install FrameworkAPI

---

Quickstart

1️⃣ Define Your Configuration (config.yaml)

scripts:
  preprocess:
    path: "scripts/preprocess.py"
    args:
      input_file: "data/raw.csv"
      output_file: "data/processed.csv"
  analyze:
    path: "scripts/analyze.R"
    args:
      input_file: "data/processed.csv"
      report_file: "results/report.html"

workflow:
  - preprocess
  - analyze

---

2️⃣ Run Scripts Using the API

from FrameworkAPI import FrameworkAPI

# Load configuration
framework = FrameworkAPI("config.yaml")

# Execute the entire workflow
framework.run_workflow()

# Or execute a single script by name
framework.run_script("preprocess")

---

3️⃣ Seamlessly Handle Multiple Languages

The module automatically detects the script type and runs the appropriate interpreter:

• .py → python
• .R → Rscript
• .jl → julia

---

Directory Structure

project/
├── config.yaml          # Your YAML configuration file
├── scripts/             # Directory for scripts
│   ├── preprocess.py    # Python script
│   ├── analyze.R        # R script
├── results/             # Output directory
└── main.py              # Main Python script

---

Advanced Features

• Cross-References in YAML: Use references to reuse values across the configuration.

  data_dir: "data/"
  scripts:
    preprocess:
      input_file: "${data_dir}raw.csv"
      output_file: "${data_dir}processed.csv"
  

• Custom Hooks: Add pre- or post-processing logic in Python for additional control.

---

Contributing

We welcome contributions! Please submit a pull request or open an issue for bug reports, feature requests, or questions.

---

License

This project is licensed under the MIT License.

---

Contact

Feel free to reach out for support or collaboration:

• Email: [e-mail]
• GitHub: GitHub Repository

---

Happy scripting! ✨