ansys-saf-cli 4.1.dev0__py3-none-any.whl

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/.github/workflows/build-release.yml

@@ -0,0 +1,175 @@
+name: build and release
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    types: [opened, reopened, synchronize, ready_for_review]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+env:
+  MAIN_PYTHON_VERSION: "3.12"
+  POETRY_VERSION: "2.3.2"
+  DOCUMENTATION_CNAME: "" # Replace with the CNAME of the documentation
+  WHEEL: "{{ cookiecutter.__solution_name }}"
+  HTML_DOCUMENTATION_ARTIFACT: "{{ cookiecutter.__solution_name }}-documentation"
+
+concurrency:
+  group: {{ "${{ github.workflow }}-${{ github.ref }}" }}
+  cancel-in-progress: true
+
+jobs:
+  check-code-style:
+    name: Check code style
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Check code style
+        uses: ansys/actions/code-style@v10
+        with:
+          python-version: {{ "${{ env.MAIN_PYTHON_VERSION }}" }}
+
+{% if cookiecutter.__ui_framework != "none" %}
+  build:
+    name: Build
+    runs-on: windows-latest
+    env:
+      # Workaround for Python toolset mismatch on windows-2025:
+      # Python's PCbuild conditionally tries to use v140 (VS 2015 toolset) when
+      # PlatformToolset is empty. However, v140 is not available on windows-2025
+      # (which has VS 2022 Enterprise), causing an MSB8020 build error.
+      # By pre-setting PlatformToolset to v143 here, the conditional check sees a
+      # non-empty value and skips the v140 assignment, using v143 instead.
+      PlatformToolset: "v143"
+    steps:
+      - name: Enable long paths
+        shell: bash
+        run: git config --global core.longpaths true
+
+      - name: Build
+        uses: ansys/saf-devops/saf-build@v1
+        with:
+          python-version: {{ "${{ env.MAIN_PYTHON_VERSION }}" }}
+          poetry-version: {{ "${{ env.POETRY_VERSION }}" }}
+          dependencies-source: "build-system"
+          artifact-name: {{ "${{ env.WHEEL }}-${{ runner.os }}" }}
+          build-result: executable
+{% endif %}
+
+  run-tests:
+    name: Run tests
+    runs-on: windows-latest
+    timeout-minutes: 20
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+      fail-fast: false
+    env:
+      # Workaround for Python toolset mismatch on windows-2025:
+      # Python's PCbuild conditionally tries to use v140 (VS 2015 toolset) when
+      # PlatformToolset is empty. However, v140 is not available on windows-2025
+      # (which has VS 2022 Enterprise), causing an MSB8020 build error.
+      # By pre-setting PlatformToolset to v143 here, the conditional check sees a
+      # non-empty value and skips the v140 assignment, using v143 instead.
+      PlatformToolset: "v143"
+    steps:
+      - name: Run tests
+        uses: ansys/actions/tests-pytest@v10
+        with:
+          python-version: {{ "${{ matrix.python-version }}" }}
+{% if cookiecutter.__ui_framework != "none" %}
+          optional-dependencies-name: "tests,ui"
+{% else %}
+          optional-dependencies-name: "tests"
+{% endif %}
+
+  check-licenses:
+    if: |
+      (github.event_name == 'push' && github.ref == 'refs/heads/main') ||
+      github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - name: Prepare python environment of the solution
+        id: python-setup
+        uses: ansys/saf-devops/prepare-python-environment@v1
+        with:
+          python-version: {{ "${{ env.MAIN_PYTHON_VERSION }}" }}
+          poetry-version: {{ "${{ env.POETRY_VERSION }}" }}
+          python-project-path: "."
+          poetry-install-args: "--all-extras"
+
+      - name: Check licenses
+        uses: ansys/actions/check-licenses@73fa84c704bb6691f254cfe4d4b928c338b0d4da # v10.3.0
+        with:
+          checkout: false
+          python-version: {{ "${{ env.MAIN_PYTHON_VERSION }}" }}
+          target: "all"
+          skip-install: true
+          activate-venv: "source {{ "${{ steps.python-setup.outputs.venv-exe-location }}" }}/activate"
+          use-uv: false
+
+  check-doc-style:
+    name: Check documentation style
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Check documentation style
+        uses: ansys/actions/doc-style@v10
+        with:
+          token: {{ "${{ github.token }}" }}
+          files: "doc"
+
+  build-doc:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    needs: check-doc-style
+    timeout-minutes: 10
+    steps:
+      - name: Build documentation
+        uses: ansys/actions/doc-build@v10
+        with:
+          python-version: {{ "${{ env.MAIN_PYTHON_VERSION }}" }}
+          check-links: true
+          optional-dependencies-name: ''
+          group-dependencies-name: 'doc'
+          uploaded-artifact-name-prefix: {{ "${{ env.HTML_DOCUMENTATION_ARTIFACT }}" }}
+        env:
+          REPOSITORY_NAME: {{ "${{ github.repository }}" }}
+
+  doc-deploy-dev:
+    name: "Deploy development documentation"
+    # Deploy development only when merging or pushing to the 'main' branch
+    if: github.event_name == 'push' && !startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    needs: build-doc
+    steps:
+      - if: {{ "${{ env.DOCUMENTATION_CNAME != '' }}" }}
+        uses: ansys/actions/doc-deploy-dev@v5
+        with:
+          doc-artifact-name: {{ "${{ env.HTML_DOCUMENTATION_ARTIFACT }}" }}-html
+          cname: {{ "${{ env.DOCUMENTATION_CNAME }}" }}
+          token: {{ "${{ github.token }}" }}
+
+  doc-deploy-stable:
+    name: "Deploy stable documentation"
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+    needs:
+      - build-doc
+    steps:
+      - if: {{ "${{ env.DOCUMENTATION_CNAME != '' }}" }}
+        uses: ansys/actions/doc-deploy-stable@v5
+        with:
+          doc-artifact-name: {{ "${{ env.HTML_DOCUMENTATION_ARTIFACT }}" }}-html
+          cname: {{ "${{ env.DOCUMENTATION_CNAME }}" }}
+          token: {{ "${{ github.token }}" }}

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/.github/workflows/label.yml

@@ -0,0 +1,89 @@
+name: Labeler
+on:
+  pull_request:
+    # opened, reopened, and synchronize are default for pull_request
+    # edited - when PR title or body is changed
+    # labeled - when labels are added to PR
+    types: [opened, reopened, synchronize, edited, labeled]
+  push:
+    branches: [ main ]
+    paths:
+      - '.github/labels.yml'
+
+concurrency:
+  group: {{ '${{ github.workflow }}-${{ github.ref }}' }}
+  cancel-in-progress: true
+
+jobs:
+
+  label-syncer:
+    name: Syncer
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: micnncim/action-label-syncer@v1
+        env:
+          GITHUB_TOKEN: {{ '${{ secrets.GITHUB_TOKEN }}' }}
+
+  labeler:
+    name: Set labels
+    needs: [label-syncer]
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+
+    # Label based on modified files
+    - name: Label based on changed files
+      uses: actions/labeler@v5
+      with:
+        repo-token: {{ "${{ secrets.GITHUB_TOKEN }}" }}
+        sync-labels: true
+
+    # Label based on branch name
+    - uses: actions-ecosystem/action-add-labels@v1
+      if: |
+        startsWith(github.event.pull_request.head.ref, 'doc') ||
+        startsWith(github.event.pull_request.head.ref, 'docs')
+      with:
+        labels: documentation
+
+    - uses: actions-ecosystem/action-add-labels@v1
+      if: |
+        startsWith(github.event.pull_request.head.ref, 'maint') ||
+        startsWith(github.event.pull_request.head.ref, 'no-ci') ||
+        startsWith(github.event.pull_request.head.ref, 'ci')
+      with:
+        labels: maintenance
+
+    - uses: actions-ecosystem/action-add-labels@v1
+      if: startsWith(github.event.pull_request.head.ref, 'feat')
+      with:
+        labels: |
+          enhancement
+
+    - uses: actions-ecosystem/action-add-labels@v1
+      if: |
+        startsWith(github.event.pull_request.head.ref, 'fix') ||
+        startsWith(github.event.pull_request.head.ref, 'patch')
+      with:
+        labels: bug
+
+  commenter:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Suggest to add labels
+      uses: peter-evans/create-or-update-comment@v2
+      # Execute only when no labels have been applied to the pull request
+      if: toJSON(github.event.pull_request.labels.*.name) == '{}'
+      with:
+        issue-number: {{ '${{ github.event.pull_request.number }}' }}
+        body: |
+          Please add one of the following labels to add this contribution to the Release Notes :point_down:
+          - [bug]({{ cookiecutter.__repository_url }}/pulls?q=label%3Abug+)
+          - [documentation]({{ cookiecutter.__repository_url }}/pulls?q=label%3Adocumentation+)
+          - [enhancement]({{ cookiecutter.__repository_url }}/pulls?q=label%3Aenhancement+)
+          - [good first issue]({{ cookiecutter.__repository_url }}/pulls?q=label%3Agood+first+issue)
+          - [maintenance]({{ cookiecutter.__repository_url }}/pulls?q=label%3Amaintenance+)
+          - [release]({{ cookiecutter.__repository_url }}/pulls?q=label%3Arelease+)

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/.gitignore

@@ -0,0 +1,137 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+# build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.whl
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+{toxworkdir}/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+coverage.json
+coverage.lcov
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+doc/build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.poetry
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Poetry
+poetry.toml

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+repos:
+
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+    - id: black
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+    - id: isort
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+    - id: flake8
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+    - id: codespell
+      args: [--skip, "doc/styles/*,doc/_build/*,*.js,*.tmp", --ignore-words, ".codespell.ignore", --exclude, "pyproject.toml,poetry.lock"]
+
+  - repo: https://github.com/pycqa/pydocstyle
+    rev: 6.3.0
+    hooks:
+    - id: pydocstyle
+      additional_dependencies: [toml]
+      exclude: "tests/"
+
+  - repo: https://github.com/ansys/pre-commit-hooks
+    rev: fd1d6b0b4baeb08e32d4de0909999576695c0433 # v0.5.2
+    hooks:
+      - id: add-license-headers
+        args:
+          - --start_year=2023
+          - --custom_template=copyright.jinja2
+
+  - repo: https://github.com/dotenv-linter/dotenv-linter
+    rev: f9076b02daed89f54ed0bd23951a4cfa5ccceac4 # v4.0.0
+    hooks:
+      - id: dotenv-linter
+        args: [check]
+
+  - repo: https://github.com/python-poetry/poetry
+    rev: a84cd0f1bedb5769ef6ef7389d8ee99b93b9ba4c # frozen: v2.3.2
+    hooks:
+      - id: poetry-check

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "{{cookiecutter.__version}}"
+}

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/.reuse/templates/copyright.jinja2

@@ -0,0 +1 @@
+Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates.

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+      "ms-python.python",
+      "ms-python.vscode-pylance",
+      "be5invis.toml",
+      "tht13.rst-vscode"
+    ]
+}

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/.vscode/launch.json

@@ -0,0 +1,28 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python: Remote Attach",
+      "type": "python",
+      "request": "attach",
+      "connect": {
+        "host": "localhost",
+        "port": 5724
+      },
+      "justMyCode": false
+    },
+    {
+      "name": "Python: Remote Attach Dash",
+      "type": "python",
+      "request": "attach",
+      "connect": {
+        "host": "localhost",
+        "port": 5725
+      },
+      "justMyCode": false
+    }
+  ]
+}

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/AUTHORS

@@ -0,0 +1,12 @@
+# This is the list of {{ cookiecutter.__solution_name }}'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/_solutions/templates/solution/{{cookiecutter.__solution_name}}/CHANGELOG.md

@@ -0,0 +1 @@
+# CHANGELOG

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/CODEOWNERS

@@ -0,0 +1,3 @@
+# Declare here default code reviewers. Checkout out official documentation:
+# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/CODE_OF_CONDUCT.md

@@ -0,0 +1,65 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our
+project and our community a harassment-free experience for everyone,
+regardless of age, body size, disability, ethnicity, sex
+characteristics, gender identity and expression, level of experience,
+education, socioeconomic status, nationality, personal appearance,
+race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual
+  attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/CONTRIBUTING.md

@@ -0,0 +1,2 @@
+# Contributing
+

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/CONTRIBUTORS.md

@@ -0,0 +1,9 @@
+# Contributors
+
+## Project Lead or Owner
+
+* [First Last]()
+
+## Individual Contributors
+
+* [First Last]()

ansys/saf/cli/_solutions/templates/solution/{{cookiecutter.__solution_name}}/LICENSE.rst

@@ -0,0 +1,41 @@
+ANSYS, Inc. Legal Notices
+==========================
+
+Copyright and Trademark Information
+------------------------------------
+
+© 2023 ANSYS, Inc. All rights reserved. Unauthorized use, distribution, or duplication is prohibited. This solution is subject to U.S. laws governing export and re-export.
+
+ANSYS, Ansys Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand, product, service and feature names, logos and slogans are registered trademarks or trademarks of ANSYS, Inc. or its subsidiaries located in the United States or other countries. ICEM CFD is a trademark used by ANSYS, Inc. under license. CFX is a trademark of Sony Corporation in Japan. All other brand, product, service, and feature names or trademarks are the property of their respective owners. FLEXlm and FLEXnet are trademarks of Flexera Software LLC.
+
+Disclaimer Notice
+-----------------
+
+THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFIDENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions of that software license agreement.
+
+ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2015 companies.
+
+U.S. Government Rights
+-----------------------
+
+For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use, duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc. software license agreement and FAR 12.212 (for non-DOD licenses).
+
+Third-Party Software Notices
+-----------------------------
+
+See the Legal Notices in the Ansys product help files for the complete Legal Notices for ANSYS proprietary software and third-party software. If you are unable to access the Legal Notices, contact ANSYS, Inc.
+
+Contact Information
+--------------------
+
+ANSYS, Inc.
+Southpointe
+2600 Ansys Drive
+Canonsburg, PA 15317
+ansysinfo@ansys.com
+<http://www.ansys.com>
+(T) 724-746-3304
+(F) 724-514-9494
+
+**Ansys Solution Applications Organization**
+Email the Solution Applications team at solution-applications.maintainers@ansys.com.