# Maximo-Automation-Script-Converter

**Repository Path**: shoukaiseki/Maximo-Automation-Script-Converter

## Basic Information

- **Project Name**: Maximo-Automation-Script-Converter
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-23
- **Last Updated**: 2026-04-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Maximo-Automation-Script-Converter
A framework designed to seamlessly transform Maximo customized Java code into Python-based automation scripts.  

**Maximo Automation Script Converter** is a Python-based framework designed to convert customized Maximo Java classes into deployable Python automation scripts. This tool streamlines the conversion process and ensures the scripts are optimized and ready for deployment in the Maximo environment.  

---

## Features  

- Converts Maximo customized Java classes into Python automation scripts.  
- Automatically creates an **Automation Script** folder in the specified directory.  
- Outputs structured `.py` files adhering to Maximo standards.  

---

## Prerequisites  

Ensure the following tools are installed on your system:  

- **Python 3.7 or above**  
- **Git**  

---

## Setup Instructions  

### 1. Clone the Repository  
Clone the repository to your local machine and navigate to the project directory:  

```bash
git clone <repository-url>
cd <repository-directory>
```

### 2. Create a Virtual Environment
Set up a Python virtual environment to isolate the dependencies:

For Linux/Mac:

```bash
python -m venv .venv
source .venv/bin/activate
```

For Windows:
```bash
python -m venv .venv
.venv\Scripts\activate
```

### 3. Install Dependencies
Install the required Python packages using the requirements.txt file:
```bash
pip install -r requirements.txt
```

### 4. Set Up Environment Variables
Create a .env file in the project root by copying the sample file provided:

```bash
cp .env.sample .env
```
Update the .env file with the necessary configurations, such as the path to your prompt file.

---

### Running the Framework

```bash
python convert.py
```

The convert.py script will prompt you to enter the folder path interactively.
Specify the folder containing your customized Java classes as an argument when running convert.py:

The framework will generate an Automation Script folder in the specified directory. The converted Python automation scripts will be stored as .py files in this folder.

---

### Sample .env File
Below is a sample .env file format for reference:
```bash
# watsonx variables
IBMC_AUTH_URL = "https://xxxxxxx/identity/token"
WX_ENDPOINT_URL = "https://xxxxxxxxxx/ml/v1/text/generation?version=2023-05-29"
WX_APIKEY = "xxxxxxxxxxxx"
WX_PROJECT_ID = "xxxxxxxxxxxx"
WX_MODEL_ID = "mistralai/mixtral-8x7b-instruct-v01"
WX_PROMPT_FILE_NAME = 'prompt.txt'
# maximo variables
MAS_URL = "https://xxxxxxxxxxxxxxx.us-south.containers.appdomain.cloud/maximo"
MAS_APIKEY = 'xxxxxxxxxxxx'
```

---

### Notes
The input folder must contain the Java custom classes you wish to convert.
All Python scripts generated by the framework will be stored in the Automation Script folder created inside the input directory.
Ensure the prompt file specified in the .env file is accurate and contains the required instructions for the conversion process.