ansys-saf-templates 0.2.dev1

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

Ensure you have all the necessary prerequisites. Then, refer to the installation guidelines for detailed instructions on how to install the project in your system.

Documentation

The official documentation of SAF Templates contains the following chapters:

• Getting started. This section provides a brief overview and instructions on how to get started with the project. It typically includes information on how to install the project, set up any necessary dependencies, and run a basic example or test to ensure everything is functioning correctly.

• User guide. The user guide section offers detailed documentation and instructions on how to use the project. It provides comprehensive explanations of the project’s features, functionalities, and configuration options. The user guide aims to help users understand the project’s concepts, best practices, and recommended workflows.

• Contribute. This section provides guidelines and instructions on how to contribute to the project. It includes information on how to set up the development environment, run tests, submit pull requests, and follow contribution guidelines.

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.

Changelog

The changelog section provides a summary of notable changes for each version of SAF Product Configuration for Python. It helps you keep track of updates, bug fixes, new features, and improvements made to the project over time.

To view the complete changelog, visit the project repository and navigate to the CHANGELOG file. It provides a comprehensive list of changes categorized by version, along with brief descriptions of each change.

How it works?

my_step/
|
├── {{cookiecutter.__solution_module_name}}/
|   |
|   ├── solution/
|   |   |
|   |   └── {{cookiecutter.__step_module_name}}.py  # definition of StepModel subclass
|   |
|   └── ui/pages/
|       |
|       └── {{cookiecutter.__ui_page_file_name}}.py  # definition of the step's UI
|
├── hooks
|   |
|   ├── pre_gen_project.py  # Not required, only if pre-generation hooks are needed
|   |
|   └── post_gen_project.py
|
└── cookiecutter.json

[templates.my-step]
location = "steps/my_step"
type = "step"
description = "a step that performs some action"

[templates.my-step.dependencies]
pendulum = ">=3.2.0"

my_template_plugin/
|
├── pyproject.toml  # includes the declaration of the plugin entry-point
|
└── src/package/templates_module
    |
    ├── __init__.py  # includes the get_plugin_path function
    |
    ├── templates.toml  # includes the configuration of the templates defined in this plugin
    |
    └── <template_structure>  # one or more directories containing the templates defined in this plugin

[project.entry-points."ansys_saf_templates"]
plugin_path = "package.templates_module:get_plugin_path"

[[tool.poetry.packages]]
include = "package/templates_module"
from = "src"

from pathlib import Path


def get_plugin_path() -> Path:
    """Return the path to the cookiecutter template."""
    return Path(__file__).parent.resolve()