ansys-saf-cli 4.1.dev0__tar.gz

ansys_saf_cli-4.1.dev0/AUTHORS

@@ -0,0 +1,12 @@
+# This is the list of SAF CLI's significant contributors.
+#
+# This file does not necessarily list everyone who has contributed code.
+#
+# For contributions made under a Corporate CLA, the organization is
+# added to this file.
+#
+# If you have contributed to the repository and want to be added to this file,
+# submit a request.
+#
+#
+ANSYS, Inc.

ansys_saf_cli-4.1.dev0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ANSYS, Inc. and/or its affiliates.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ansys_saf_cli-4.1.dev0/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: ansys-saf-cli
+Version: 4.1.dev0
+Summary: Command line interface for developing SAF solutions from scaffolding to packaging.
+License: Apache-2.0
+License-File: AUTHORS
+License-File: LICENSE
+Keywords: solution application framework,python,saf,solution
+Author: ANSYS, Inc.
+Author-email: pyansys.core@ansys.com
+Maintainer: ANSYS, Inc.
+Maintainer-email: pyansys.core@ansys.com
+Requires-Python: >=3.10,<4
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Other Audience
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+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 :: Scientific/Engineering
+Requires-Dist: ansys-saf-templates (>=0.2.dev2,<1.0.0)
+Requires-Dist: chardet (>=5.2.0,<7)
+Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: cookiecutter (>=2.6.0,<3.0.0)
+Requires-Dist: packaging (>=24.2,<25.0)
+Requires-Dist: pydantic (>=2.7,<3.0)
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Requires-Dist: tomlkit (>=0.14.0,<1.0.0)
+Description-Content-Type: text/x-rst
+
+#####################################################
+Solution Application Framework - CLI
+#####################################################
+
+|python| |pypi| |GH-CI| |codecov| |Apache| |ruff|
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-saf-cli?logo=python&logoColor=white&label=Python
+   :target: https://pypi.org/project/ansys-saf-cli/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-saf-cli.svg?logo=pypi&logoColor=white&label=PyPI
+   :target: https://pypi.org/project/ansys-saf-cli/
+   :alt: PyPI
+
+.. |GH-CI| image:: https://github.com/ansys/saf-cli/actions/workflows/ci_cd_release.yml/badge.svg?label=CI
+   :target: https://github.com/ansys/saf-cli/actions/workflows/ci_cd_release.yml
+   :alt: GH-CI
+
+.. |codecov| image:: https://img.shields.io/codecov/c/github/ansys/saf-cli
+   :target: https://app.codecov.io/gh/ansys/saf-cli
+   :alt: Codecov
+
+.. |Apache| image:: https://img.shields.io/badge/License-Apache2.0-white.svg?labelColor=black
+   :target: https://www.apache.org/licenses/
+   :alt: Apache
+
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :target: https://github.com/astral-sh/ruff
+   :alt: Ruff
+
+
+Overview
+========
+
+SAF CLI is a command-line tool that streamlines the development, management, and packaging of SAF-based solutions.
+It provides a unified developer workflow for common SAF tasks such as scaffolding new solutions, installing and
+managing solution environments, running solutions locally, executing commands in the correct Python environment,
+building distributable installers, archiving solution source code, and listing registered solutions. Under the hood,
+it helps coordinate the tools and services involved in the SAF ecosystem so that developers can work with solutions
+through a consistent command set instead of stitching together manual steps.
+
++------------+------------------------------------------------------------------+
+| Command    | Description                                                      |
++============+==================================================================+
+| new        | Scaffold a new SAF solution from a template.                     |
++------------+------------------------------------------------------------------+
+| install    | Set up the solution development environment and dependencies.    |
++------------+------------------------------------------------------------------+
+| run        | Run a solution locally for development and testing.              |
++------------+------------------------------------------------------------------+
+| execute    | Run arbitrary commands in the solution Python environment.       |
++------------+------------------------------------------------------------------+
+| build      | Build a distributable package or installer for a solution.       |
++------------+------------------------------------------------------------------+
+| add-step   | Add a new step to an existing SAF solution.                      |
++------------+------------------------------------------------------------------+
+| archive    | Archive a solution source tree into a distributable bundle.      |
++------------+------------------------------------------------------------------+
+| solutions  | List the solutions registered in the SAF solution database.      |
++------------+------------------------------------------------------------------+
+| doc        | Open the SAF CLI documentation.                                  |
++------------+------------------------------------------------------------------+
+
+The CLI is designed to improve developer productivity and solution consistency across the full solution lifecycle.
+It reduces setup friction for new projects, lowers the amount of custom scripting teams need to maintain, and makes
+local development, packaging, and delivery more repeatable.
+
+
+Installation
+============
+
+Ensure you have all the necessary `prerequisites`_. Then, refer to the
+`installation guidelines`_ for detailed instructions on how to install the
+project on your system.
+
+
+Documentation
+=============
+
+The `official documentation`_ of SAF CLI 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, please open an issue in the project
+repository.
+
+Please 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.
+
+
+Using GitHub Copilot for Development
+=====================================
+
+This repository includes a `Copilot instructions file <https://github.com/ansys/saf-cli/blob/main/.github/copilot-instructions.md>`_ that provides AI-assisted development guidance. When working on SAF CLI enhancements or bug fixes:
+
+#. GitHub Copilot will automatically reference the project structure, architecture, and development guidelines from the instructions file.
+#. The instructions cover core concepts like solution resolution, dependency groups, environment management, and code style expectations.
+#. Use Copilot to generate code that follows the established patterns for CLI commands, configuration management, and integrations.
+#. The instructions emphasize type hints, Google-style docstrings, and the modular structure of the codebase.
+
+This helps ensure consistency across contributions and speeds up development workflows.
+
+**Suggested Copilot Prompt:**
+
+When starting a new feature or fix, you can use a prompt like this to guide Copilot:
+
+    "I'm working on the SAF CLI project. [Describe your task]. Please follow the project's Copilot instructions,
+    including using Click for CLI commands, type hints, Google-style docstrings, and the existing modular structure
+    in src/ansys/saf/cli/. Ensure the code integrates with the existing modules and includes appropriate error handling."
+
+This prompt helps ensure Copilot generates code that aligns with SAF CLI's architecture and standards.
+
+
+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 CLI 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.
+
+
+.. _official documentation: https://saf-cli.docs.solutions.ansys.com
+.. _prerequisites: https://saf-cli.docs.solutions.ansys.com
+.. _installation guidelines: https://saf-cli.docs.solutions.ansys.com/version/stable/getting_started
+.. _Getting started: https://saf-cli.docs.solutions.ansys.com/version/stable/getting_started/index.html
+.. _User guide: https://saf-cli.docs.solutions.ansys.com/version/stable/user_guide/index.html
+.. _Contribute: https://saf-cli.docs.solutions.ansys.com/version/stable/contribute/index.html
+.. _LICENSE: https://github.com/ansys/saf-cli/blob/main/LICENSE
+.. _CHANGELOG: https://github.com/ansys/saf-cli/blob/main/CHANGELOG.md
+

ansys_saf_cli-4.1.dev0/README.rst

@@ -0,0 +1,166 @@
+#####################################################
+Solution Application Framework - CLI
+#####################################################
+
+|python| |pypi| |GH-CI| |codecov| |Apache| |ruff|
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-saf-cli?logo=python&logoColor=white&label=Python
+   :target: https://pypi.org/project/ansys-saf-cli/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-saf-cli.svg?logo=pypi&logoColor=white&label=PyPI
+   :target: https://pypi.org/project/ansys-saf-cli/
+   :alt: PyPI
+
+.. |GH-CI| image:: https://github.com/ansys/saf-cli/actions/workflows/ci_cd_release.yml/badge.svg?label=CI
+   :target: https://github.com/ansys/saf-cli/actions/workflows/ci_cd_release.yml
+   :alt: GH-CI
+
+.. |codecov| image:: https://img.shields.io/codecov/c/github/ansys/saf-cli
+   :target: https://app.codecov.io/gh/ansys/saf-cli
+   :alt: Codecov
+
+.. |Apache| image:: https://img.shields.io/badge/License-Apache2.0-white.svg?labelColor=black
+   :target: https://www.apache.org/licenses/
+   :alt: Apache
+
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :target: https://github.com/astral-sh/ruff
+   :alt: Ruff
+
+
+Overview
+========
+
+SAF CLI is a command-line tool that streamlines the development, management, and packaging of SAF-based solutions.
+It provides a unified developer workflow for common SAF tasks such as scaffolding new solutions, installing and
+managing solution environments, running solutions locally, executing commands in the correct Python environment,
+building distributable installers, archiving solution source code, and listing registered solutions. Under the hood,
+it helps coordinate the tools and services involved in the SAF ecosystem so that developers can work with solutions
+through a consistent command set instead of stitching together manual steps.
+
++------------+------------------------------------------------------------------+
+| Command    | Description                                                      |
++============+==================================================================+
+| new        | Scaffold a new SAF solution from a template.                     |
++------------+------------------------------------------------------------------+
+| install    | Set up the solution development environment and dependencies.    |
++------------+------------------------------------------------------------------+
+| run        | Run a solution locally for development and testing.              |
++------------+------------------------------------------------------------------+
+| execute    | Run arbitrary commands in the solution Python environment.       |
++------------+------------------------------------------------------------------+
+| build      | Build a distributable package or installer for a solution.       |
++------------+------------------------------------------------------------------+
+| add-step   | Add a new step to an existing SAF solution.                      |
++------------+------------------------------------------------------------------+
+| archive    | Archive a solution source tree into a distributable bundle.      |
++------------+------------------------------------------------------------------+
+| solutions  | List the solutions registered in the SAF solution database.      |
++------------+------------------------------------------------------------------+
+| doc        | Open the SAF CLI documentation.                                  |
++------------+------------------------------------------------------------------+
+
+The CLI is designed to improve developer productivity and solution consistency across the full solution lifecycle.
+It reduces setup friction for new projects, lowers the amount of custom scripting teams need to maintain, and makes
+local development, packaging, and delivery more repeatable.
+
+
+Installation
+============
+
+Ensure you have all the necessary `prerequisites`_. Then, refer to the
+`installation guidelines`_ for detailed instructions on how to install the
+project on your system.
+
+
+Documentation
+=============
+
+The `official documentation`_ of SAF CLI 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, please open an issue in the project
+repository.
+
+Please 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.
+
+
+Using GitHub Copilot for Development
+=====================================
+
+This repository includes a `Copilot instructions file <https://github.com/ansys/saf-cli/blob/main/.github/copilot-instructions.md>`_ that provides AI-assisted development guidance. When working on SAF CLI enhancements or bug fixes:
+
+#. GitHub Copilot will automatically reference the project structure, architecture, and development guidelines from the instructions file.
+#. The instructions cover core concepts like solution resolution, dependency groups, environment management, and code style expectations.
+#. Use Copilot to generate code that follows the established patterns for CLI commands, configuration management, and integrations.
+#. The instructions emphasize type hints, Google-style docstrings, and the modular structure of the codebase.
+
+This helps ensure consistency across contributions and speeds up development workflows.
+
+**Suggested Copilot Prompt:**
+
+When starting a new feature or fix, you can use a prompt like this to guide Copilot:
+
+    "I'm working on the SAF CLI project. [Describe your task]. Please follow the project's Copilot instructions,
+    including using Click for CLI commands, type hints, Google-style docstrings, and the existing modular structure
+    in src/ansys/saf/cli/. Ensure the code integrates with the existing modules and includes appropriate error handling."
+
+This prompt helps ensure Copilot generates code that aligns with SAF CLI's architecture and standards.
+
+
+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 CLI 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.
+
+
+.. _official documentation: https://saf-cli.docs.solutions.ansys.com
+.. _prerequisites: https://saf-cli.docs.solutions.ansys.com
+.. _installation guidelines: https://saf-cli.docs.solutions.ansys.com/version/stable/getting_started
+.. _Getting started: https://saf-cli.docs.solutions.ansys.com/version/stable/getting_started/index.html
+.. _User guide: https://saf-cli.docs.solutions.ansys.com/version/stable/user_guide/index.html
+.. _Contribute: https://saf-cli.docs.solutions.ansys.com/version/stable/contribute/index.html
+.. _LICENSE: https://github.com/ansys/saf-cli/blob/main/LICENSE
+.. _CHANGELOG: https://github.com/ansys/saf-cli/blob/main/CHANGELOG.md