ansys-tools-common 0.2.0__tar.gz

ansys_tools_common-0.2.0/.github/CODEOWNERS

@@ -0,0 +1,13 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# they will be requested for review when someone opens a pull request.
+* @ansys/ansys-common-tools-maintainers
+
+# Local launcher
+/src/ansys/common/tools/launcher/* @greschd
+
+# Documentation
+/doc/source/* @PipKat

ansys_tools_common-0.2.0/.github/dependabot.yml

@@ -0,0 +1,43 @@
+version: 2
+updates:
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    cooldown:
+      default-days: 5
+      include:
+        - "*"
+      exclude:
+        - "ansys-sphinx-theme"
+        - "ansys-tools-visualization-interface"
+    labels:
+      - "maintenance"
+      - "dependencies"
+    assignees:
+      - "pyansys-ci-bot"
+    commit-message:
+      prefix: "build"
+    groups:
+      grpc-deps:
+        patterns:
+          - "grpc*"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    cooldown:
+      default-days: 5
+      include:
+        - "*"
+      exclude:
+        - "ansys/actions/*"
+    labels:
+      - "maintenance"
+      - "dependencies"
+    assignees:
+      - "pyansys-ci-bot"
+    commit-message:
+      prefix: "ci"

ansys_tools_common-0.2.0/.github/labeler.yml

@@ -0,0 +1,11 @@
+documentation:
+  - changed-files:
+      - any-glob-to-any-file: [doc/source/**/*, README.md]
+
+maintenance:
+  - changed-files:
+      - any-glob-to-any-file: [.github/**/*, pyproject.toml, tox.ini, .pre-commit-config.yaml]
+
+testing:
+  - changed-files:
+      - any-glob-to-any-file: [tests/*]

ansys_tools_common-0.2.0/.github/labels.yml

@@ -0,0 +1,43 @@
+- name: bug
+  description: Something isn't working
+  color: d42a34
+
+- name: dependencies
+  description: Related with project dependencies
+  color: ffc0cb
+
+- name: documentation
+  description: Improvements or additions to documentation
+  color: 0677ba
+
+- name: enhancement
+  description: New features or code improvements
+  color: FFD827
+
+- name: good first issue
+  description: Easy to solve for newcomers
+  color: 62ca50
+
+- name: maintenance
+  description: Package and maintenance related
+  color: f78c37
+
+- name: release
+  description: Anything related to an incoming release
+  color: ffffff
+
+- name: testing
+  description: Anything related to testing
+  color: 5802B8
+
+- name: graphics
+  description: Anything related to graphics
+  color: 5903A8
+
+- name: triage
+  description: Need some assessment
+  color: f78a50
+
+- name: top priority
+  description: Must be fixed promptly
+  color: ab8a50

ansys_tools_common-0.2.0/.github/workflows/cicd.yml

@@ -0,0 +1,219 @@
+name: GitHub CI
+
+on:
+  pull_request:
+  workflow_dispatch:
+  push:
+    tags:
+      - '*'
+    branches:
+      - main
+
+env:
+  PACKAGE_NAME: ansys-tools-common
+  MAIN_PYTHON_VERSION: 3.13
+  DOCUMENTATION_CNAME: tools.docs.pyansys.com
+
+permissions:
+  contents: read
+
+jobs:
+
+  changelog:
+    name: Changelog
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Create fragment
+        if: github.event_name == 'pull_request'
+        uses: ansys/actions/doc-changelog@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
+
+      - name: Deploy changelog
+        if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+        uses: ansys/actions/doc-deploy-changelog@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
+
+  vulnerabilities:
+    name: Check library vulnerabilities
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ansys/actions/check-vulnerabilities@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+          python-package-name: ${{ env.PACKAGE_NAME }}
+          dev-mode: ${{ github.ref != 'refs/heads/main' }}
+
+  code-style:
+    name: Code style
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ansys/actions/code-style@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  doc-style:
+    name: Doc style
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ansys/actions/doc-style@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  actions-style:
+    name: Actions style
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ansys/actions/check-actions-security@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          generate-summary: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+          auditing-level: high
+
+  wheelhouse:
+    name: Wheelhouse / ${{ matrix.os }} / ${{ matrix.python }}
+    runs-on: ${{ matrix.os }}
+    needs: code-style
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python: ['3.10', '3.11', '3.12', '3.13']
+    steps:
+      - uses: ansys/actions/build-wheelhouse@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          operating-system: ${{ matrix.os }}
+          python-version: ${{ matrix.python }}
+          whitelist-license-check: termcolor # Has MIT license, but it's not recognized
+
+  tests:
+    name: Testing
+    runs-on: ubuntu-latest
+    needs: wheelhouse
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python: ['3.10', '3.11', '3.12', '3.13']
+    env:
+      ANSYS_LOCAL: false
+      ON_UBUNTU: true
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0
+        with:
+          persist-credentials: false
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@eb1897b8dc4b5d5bfe39a428a8f2304605e0983c # 7.0.0
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          enable-cache: false
+
+      - name: Install project dependencies
+        run: |
+          uv sync --group tests
+
+      - name: Install test package containing entrypoint
+        run: |
+          uv pip install tests/launcher/pkg_with_entrypoint
+
+      - name: Run tests
+        run: |
+          uv run pytest
+
+  doc-build:
+    name: Build documentation
+    needs: doc-style
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ansys/actions/doc-build@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          check-links: false
+          group-dependencies-name: doc
+
+  build-library:
+    name: Build library
+    runs-on: ubuntu-latest
+    needs: [doc-build, tests]
+    steps:
+      - uses: ansys/actions/build-library@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          library-name: ${{ env.PACKAGE_NAME }}
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+  release:
+    name: Release project
+    if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
+    needs: build-library
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+        with:
+          name: ${{ env.PACKAGE_NAME }}-artifacts
+          path: ${{ env.PACKAGE_NAME }}-artifacts
+
+      - name: Release to the public PyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0
+        with:
+          repository-url: https://upload.pypi.org/legacy/
+          print-hash: true
+          packages-dir: ${{ env.PACKAGE_NAME }}-artifacts
+          skip-existing: false
+
+      - name: Release to GitHub
+        uses: ansys/actions/release-github@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          library-name: ${{ env.PACKAGE_NAME }}
+
+  doc-deploy-stable:
+    name: Deploy stable docs
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    needs: release
+    steps:
+      - uses: ansys/actions/doc-deploy-stable@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
+
+  automerge-prs:
+    name: Automerge PRs (dependabot and pre-commit.ci only)
+    runs-on: ubuntu-latest
+    needs: [build-library]
+    if: github.event_name == 'pull_request'
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Automerge PRs
+        uses: ansys/actions/hk-automerge-prs@c2fa7c93f6883114e0e643599431b33d29f0b13f # v10.1.4
+        with:
+          approver: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          approver-token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+
+      - name: If pre-commit PR, add assignee
+        if: startsWith(github.head_ref, 'pre-commit-ci-update-config')
+        run: gh pr edit --add-assignee pyansys-ci-bot "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}

ansys_tools_common-0.2.0/.github/workflows/label.yml

@@ -0,0 +1,104 @@
+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:
+      - ../labels.yml
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions: {} # Disable default permissions
+
+jobs:
+
+  label-syncer:
+    name: Syncer
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+      - uses: micnncim/action-label-syncer@3abd5ab72fda571e69fffd97bd4e0033dd5f495c # v1.3.0
+        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@634933edcd8ababfe52f92936142cc22ac488b1b # v6.0.1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          sync-labels: true
+
+      # Label based on branch name
+      - uses: actions-ecosystem/action-add-labels@18f1af5e3544586314bbe15c0273249c770b2daf # v1.1.3
+        if: |
+          startsWith(github.event.pull_request.head.ref, 'doc') ||
+          startsWith(github.event.pull_request.head.ref, 'docs')
+        with:
+          labels: documentation
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions-ecosystem/action-add-labels@18f1af5e3544586314bbe15c0273249c770b2daf # v1.1.3
+        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
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions-ecosystem/action-add-labels@18f1af5e3544586314bbe15c0273249c770b2daf # v1.1.3
+        if: startsWith(github.event.pull_request.head.ref, 'feat')
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          labels: |
+            enhancement
+
+      - uses: actions-ecosystem/action-add-labels@18f1af5e3544586314bbe15c0273249c770b2daf # v1.1.3
+        if: |
+          startsWith(github.event.pull_request.head.ref, 'fix') ||
+          startsWith(github.event.pull_request.head.ref, 'patch')
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          labels: bug
+
+  commenter:
+    name: Suggest labels if none assigned
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - name: Suggest to add labels
+        uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0
+        # 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](https://github.com/ansys/ansys-tools-common/pulls?q=label%3Abug+)
+            - [documentation](https://github.com/ansys/ansys-tools-common/pulls?q=label%3Adocumentation+)
+            - [enhancement](https://github.com/ansys/ansys-tools-common/pulls?q=label%3Aenhancement+)
+            - [good first issue](https://github.com/ansys/ansys-tools-common/pulls?q=label%3Agood+first+issue)
+            - [maintenance](https://github.com/ansys/ansys-tools-common/pulls?q=label%3Amaintenance+)
+            - [release](https://github.com/ansys/ansys-tools-common/pulls?q=label%3Arelease+)

ansys_tools_common-0.2.0/.github/workflows/run_mapdl_tests.yml

@@ -0,0 +1,60 @@
+name: MAPDL dependent tests for paths tool
+
+on:
+  pull_request:
+  workflow_dispatch:
+  push:
+    tags:
+      - '*'
+    branches:
+      - main
+
+env:
+  PACKAGE_NAME: ansys-tools-common
+  MAIN_PYTHON_VERSION: 3.13
+
+permissions:
+  contents: read
+  packages: read
+
+jobs:
+
+  build-tests:
+    name: Build tests
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/ansys/mapdl:v22.2-ubuntu@sha256:024c587f4a8190e99cc3f08a2dc231583032e784a8ef7d7659f8dd9748116697
+      options: -u=0:0 --entrypoint /bin/bash
+      credentials:
+        username: ${{ secrets.GH_USERNAME }}
+        password: ${{ secrets.GH_TOKEN }}
+    env:
+      ANSYS_LOCAL: true
+      ON_UBUNTU: true
+
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@eb1897b8dc4b5d5bfe39a428a8f2304605e0983c # 7.0.0
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+          enable-cache: false
+
+      - name: Install project dependencies
+        run: |
+          uv sync --group tests
+
+      - name: Install test package containing entrypoint
+        run: |
+          uv pip install tests/launcher/pkg_with_entrypoint
+
+      - name: Run tests
+        env:
+          PACKAGE_NAMESPACE: ${{ env.PACKAGE_NAMESPACE }}
+        run: |
+          uv run pytest \
+            -vx \
+            --cov=${PACKAGE_NAMESPACE} --cov-report=term --cov-report=xml:.cov/coverage.xml --cov-report=html:.cov/html

ansys_tools_common-0.2.0/.gitignore

@@ -0,0 +1,180 @@
+# 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
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.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
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+.vscode
+._build
+
+doc/source/api
+.cov
+not_a_dir