Metadata-Version: 2.1
Name: alibabacloud-ros-tran
Version: 0.28.1
Summary: Resource Orchestration Service Template Transformer.
Home-page: https://www.alibabacloud.com/product/ros
Author: AlibabaCloud
Author-email: AlibabaCloud <aliyun-developers-efficiency@list.alibaba-inc.com>
License: Apache License 2.0
Project-URL: Homepage, https://www.alibabacloud.com/product/ros
Keywords: alibabacloud,aliyun,ros,transformer,template
Platform: any
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.9.0
Description-Content-Type: text/markdown
Provides-Extra: binary
Provides-Extra: dev
Provides-Extra: serve
License-File: LICENSE

<p align="center">
  <img src="website/static/img/logo.svg" alt="ROS Template Transformer logo" width="96" height="96">
</p>

# ROS Template Transformer

[![alibabacloud-ros-tran](https://img.shields.io/pypi/v/alibabacloud-ros-tran.svg)](https://pypi.python.org/pypi/alibabacloud-ros-tran)
[![alibabacloud-ros-tran](https://img.shields.io/pypi/pyversions/alibabacloud-ros-tran.svg)](https://pypi.python.org/pypi/alibabacloud-ros-tran)


[ROS(Resource Orchestration Service)](https://www.alibabacloud.com/help/resource-orchestration-service) 
Template Transformer is a tool for transforming and formatting.

- Transforms **AWS CloudFormation/Terraform/Excel** template to **ROS** template.
- Formats ROS template.

## Requirements

- Python 3.9+ (tested with Python 3.9 through 3.14)

## Installation

```bash
pip install alibabacloud-ros-tran
```

## Web UI

A browser-based playground is available for transforming and formatting
templates without the command line. Install the optional `serve` extra and
start the local web service:

```bash
pip install "alibabacloud-ros-tran[serve]"
rostran server start
```

This serves `http://127.0.0.1:8080` with a dual-pane editor for converting
CloudFormation / Terraform / Excel / ROS templates and formatting ROS templates.
Terraform conversions reuse a bounded project cache at
`~/.cache/rostran/terraform-projects` by default; override it with
`ROSTRAN_TERRAFORM_CACHE_DIR` and set `ROSTRAN_TERRAFORM_CACHE_MAX_PROJECTS`
to change the cache size.
The service runs in the background; manage it with:

```bash
rostran server status   # show whether it is running
rostran server stop     # stop it
```

Use `rostran server start --foreground` to run it in the foreground, and
`rostran server start --help` for host, port and other options.

## Document

Fantastic documentation is available at:
[English](https://aliyun.github.io/alibabacloud-ros-tool-transformer/) |
[中文版](https://aliyun.github.io/alibabacloud-ros-tool-transformer/zh-cn/).
