ansys-saf-templates 0.2.dev3

Overview

SAF Templates is a collection of Cookiecutter-based templates that help developers quickly scaffold common components for SAF-based solution applications. Instead of writing boilerplate code from scratch, developers can generate ready-to-use solution steps, pages, and supporting files through the SAF CLI, then customize them to fit their specific use case.

The package currently ships the following built-in step templates:

Beyond the built-in templates, SAF Templates supports a plugin architecture that allows developers and teams to create, package, and share their own template repositories. This means you can build reusable templates tailored to your organization’s patterns and distribute them across projects or to the wider community.

Contributions are welcomed. If you have a useful template that could benefit other SAF developers, consider contributing it back to the project or publishing your own template plugin repository.

Installation

SAF Templates comes bundled with SAF CLI since SAF CLI version 3.7. However, it is mandatory to have SAF CLI version 4.0.1 or later installed to use the templates. Using previous versions of SAF CLI might produce unexpected results or even errors when attempting to add a step. This documentation assumes that SAF CLI version 4.0.1 or later is installed.

Use the following command if you want to manually install a newer version of the SAF Templates package. Make sure to install it in the python environment where SAF CLI is installed:

pip install ansys-saf-templates

Quick start

You can list the available templates by running:

saf templates

This will show all the templates available in ansys-saf-templates as well as any additional templates from installed plugins.

Add a new step to your solution using the SAF CLI command:

saf add-step <my_solution>

The CLI will interactively guide you through selecting a template and providing the required parameters. Otherwise, you can directly pass all the necessary information as command-line arguments:

saf add-step <my_solution> --step-name <step_name> --ui-framework <ui_framework> --template <template_name>

Documentation

The official documentation contains:

• Overview — What SAF Templates is and its key features.

• User guide — Installation, prerequisites, and usage instructions.

• Template gallery — Browse all available templates.

• Contribute — How to add your own templates.

Troubleshooting

For troubleshooting or reporting issues, open an issue in the project repository.

Follow these steps to report an issue:

• Go to the project repository.

• Click on the Issues tab.

• Click on the New Issue button.

• Provide a clear and detailed description of the issue you are facing.

• Include any relevant error messages, code snippets, or screenshots.

Additionally, you can refer to the official documentation for additional resources and troubleshooting guides.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.