Merge branch 'main' of https://github.com/ansys-internal/ansys-tools-…

…local-product-launcher into maint/release_0.1.1

.github/workflows/ci_cd.yml

@@ -9,7 +9,7 @@ on:
   workflow_dispatch:
 
 env:
-  MAIN_PYTHON_VERSION: '3.12'
+  MAIN_PYTHON_VERSION: '3.13'
   DOCUMENTATION_CNAME: 'local-product-launcher.tools.docs.pyansys.com'
   PACKAGE_NAME: 'ansys-tools-local-product-launcher'
 
@@ -38,7 +38,7 @@ jobs:
     name: "Documentation style"
     runs-on: ubuntu-latest
     steps:
-      - uses: ansys/actions/doc-style@v5
+      - uses: ansys/actions/doc-style@v8
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -48,15 +48,15 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
         should-release:
           - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
         exclude:
           - should-release: false
             os: macos-latest
     steps:
       - name: "Build wheelhouse and perform smoke test"
-        uses: ansys/actions/build-wheelhouse@v5
+        uses: ansys/actions/build-wheelhouse@v8
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           operating-system: ${{ matrix.os }}
@@ -68,7 +68,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-latest, ubuntu-latest]
-        python-version: ['3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
       fail-fast: false
 
     steps:
@@ -90,15 +90,14 @@ jobs:
           name: coverage-report-html
           path: htmlcov
           retention-days: 7
-      # TODO: Uncomment once publicly released
-      #
-      # - name: "Upload coverage to Codecov"
-      #   uses: codecov/codecov-action@v4
-      #   if: matrix.os == 'ubuntu-latest' && matrix.python-version == env.MAIN_PYTHON_VERSION
-      #   env:
-      #     CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-      #   with:
-      #     files: coverage.xml
+
+      - name: "Upload coverage to Codecov"
+        uses: codecov/codecov-action@v5
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == env.MAIN_PYTHON_VERSION
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          files: coverage.xml
 
   docs:
     name: Documentation
@@ -122,6 +121,7 @@ jobs:
           retention-days: 7
       - name: "Install OS packages for PDF"
         run: |
+          sudo apt-get update
           sudo apt-get install latexmk texlive-latex-extra
       - name: Generate the PDF documentation with tox
         run: tox -e doc-linux-pdf
@@ -138,7 +138,7 @@ jobs:
     needs: [style, tests, doc-style, docs, build-wheelhouse]
     steps:
       - name: "Build library source and wheel artifacts"
-        uses: ansys/actions/build-library@v5
+        uses: ansys/actions/build-library@v8
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
@@ -150,14 +150,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release to the public PyPI repository
-        uses: ansys/actions/release-pypi-public@v5
+        uses: ansys/actions/release-pypi-public@v8
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           twine-username: "__token__"
           twine-token: ${{ secrets.PYPI_TOKEN }}
 
       - name: Release to GitHub
-        uses: ansys/actions/release-github@v5
+        uses: ansys/actions/release-github@v8
         with:
           library-name: ${{ env.PACKAGE_NAME }}
 
@@ -168,10 +168,12 @@ jobs:
     needs: [build]
     steps:
       - name: Deploy the latest documentation
-        uses: ansys/actions/doc-deploy-dev@v5
+        uses: ansys/actions/doc-deploy-dev@v8
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
 
   upload_docs_release:
     name: Upload release documentation
@@ -180,7 +182,9 @@ jobs:
     needs: [release]
     steps:
       - name: Deploy the stable documentation
-        uses: ansys/actions/doc-deploy-stable@v5
+        uses: ansys/actions/doc-deploy-stable@v8
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}

.pre-commit-config.yaml

@@ -1,13 +1,13 @@
 repos:
 
 - repo: https://github.com/asottile/pyupgrade
-  rev: v3.15.0
+  rev: v3.18.0
   hooks:
   - id: pyupgrade
-    args: [--py39-plus]
+    args: [--py310-plus]
 
 - repo: https://github.com/psf/black
-  rev: 24.1.1
+  rev: 24.10.0
   hooks:
   - id: black
 
@@ -17,18 +17,19 @@ repos:
   - id: isort
 
 - repo: https://github.com/pycqa/flake8
-  rev: 7.0.0
+  rev: 7.1.1
   hooks:
   - id: flake8
 
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.2.6
+  rev: v2.3.0
   hooks:
   - id: codespell
-    exclude: "poetry\\.lock"
+    additional_dependencies: ["tomli"] # needed to parse pyproject.toml
+    exclude: '^poetry\.lock|pyproject\.toml$'
 
 - repo: https://github.com/python-poetry/poetry/
-  rev: '1.7.0'
+  rev: '1.8.0'
   hooks:
   - id: poetry-check
     name: "poetry: check pyproject.toml syntax"
@@ -47,7 +48,7 @@ repos:
     exclude: "^(tests/|examples/example_scripts/)"
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.2.8
+  rev: v0.4.3
   hooks:
   - id: add-license-headers
     args: ["--start_year", "2022"]

AUTHORS

@@ -5,8 +5,8 @@
 # For contributions made under a Corporate CLA, the organization is
 # added to this file.
 #
-# If you have contributed to the repository and wish to be added to this file
-# please submit a request.
+# If you have contributed to the repository and want to be added to this file,
+# submit a request.
 #
 #
 ANSYS, Inc.

CODE_OF_CONDUCT.md

@@ -7,7 +7,7 @@ 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, socio-economic status, nationality, personal appearance,
+education, socioeconomic status, nationality, personal appearance,
 race, religion, or sexual identity and orientation.
 
 ## Our Standards

CONTRIBUTORS.md

@@ -1,6 +1,6 @@
 # Contributors
 
-## Project Lead or Owner
+## Project Lead
 
 * [Dominik Gresch](https://github.com/greschd)
 

LICENSE

@@ -1,13 +1,13 @@
 MIT License
 
-Copyright (c) 2022 - 2024 ANSYS, Inc. All rights reserved.
+Copyright (c) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

doc/.vale.ini

@@ -27,6 +27,8 @@ Vocab = ANSYS, CustomVocab
 # Apply the following styles
 BasedOnStyles = Vale, Google
 
+Vale.Terms = NO
+
 TokenIgnores = ((:py)?:(func|class|meth|attr|py):`(?:.|\n)*?`)|(<.*>)|(.. code::.*\n|    .*)
 
 # Removing Google-specific rule - Not applicable under some circumstances

doc/source/conf.py

@@ -3,8 +3,7 @@
 from datetime import datetime
 import os
 
-from ansys_sphinx_theme import ansys_favicon, get_version_match, pyansys_logo_black
-from sphinx_gallery.sorting import FileNameSortKey
+from ansys_sphinx_theme import ansys_favicon, get_version_match
 
 from ansys.tools.local_product_launcher import __version__
 
@@ -15,7 +14,6 @@
 release = version = __version__
 
 # Select desired logo, theme, and declare the html title
-html_logo = pyansys_logo_black
 html_favicon = ansys_favicon
 html_theme = "ansys_sphinx_theme"
 html_short_title = html_title = "ansys-tools-local-product-launcher"
@@ -24,14 +22,15 @@
 cname = os.environ.get("DOCUMENTATION_CNAME", "local-product-launcher.tools.docs.pyansys.com")
 """The canonical name of the webpage hosting the documentation."""
 html_theme_options = {
+    "logo": "pyansys",
     "github_url": "https://github.com/ansys/ansys-tools-local-product-launcher",
-    "show_prev_next": False,
+    "show_prev_next": True,
     "show_breadcrumbs": True,
     "additional_breadcrumbs": [
         ("PyAnsys", "https://docs.pyansys.com/"),
     ],
     "switcher": {
-        "json_url": f"https://{cname}/release/versions.json",
+        "json_url": f"https://{cname}/versions.json",
         "version_match": get_version_match(__version__),
     },
     "check_switcher": False,
@@ -122,7 +121,7 @@
     # Remove the "Download all examples" button from the top level gallery
     "download_all_examples": False,
     # Sort gallery example by file name instead of number of lines (default)
-    "within_subsection_order": FileNameSortKey,
+    "within_subsection_order": "FileNameSortKey",
     # directory where function granular galleries are stored
     "backreferences_dir": None,
     # Modules for which function level galleries are created.  In