chore: Deprecate library (#342)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>

Author: 4 people

.github/workflows/ci_cd.yml

@@ -85,11 +85,6 @@ jobs:
         run: |
           python -m pytest -vx --cov=${{ env.PACKAGE_NAMESPACE }} --cov-report=term --cov-report=xml:.cov/coverage.xml --cov-report=html:.cov/html
 
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v5
-        with:
-          files: .cov/coverage.xml
-
   docs-style:
     name: Documentation style check
     runs-on: ubuntu-latest
@@ -108,7 +103,6 @@ jobs:
         uses: ansys/actions/doc-build@v10
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
-          dependencies: "build-essential zip pandoc texlive-latex-extra latexmk texlive-pstricks"
 
   package:
     name: Package library

README.rst

@@ -1,5 +1,8 @@
-ansys-tools-path
-================
+[DEPRECATED] ansys-tools-path
+=============================
+This library is deprecated and will no longer be maintained. Please consider using alternatives. For more information check
+`this issue <https://github.com/ansys/ansys-tools-path/issues/341>`_.
+
 
 |pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|
 

doc/changelog.d/342.maintenance.md

@@ -0,0 +1 @@
+Deprecate library

doc/source/conf.py

@@ -72,6 +72,8 @@
 numpydoc_show_class_members = False
 numpydoc_xref_param_type = True
 
+suppress_warnings = ["autoapi.python_import_resolution"]
+
 # Consider enabling numpydoc validation. See:
 # https://numpydoc.readthedocs.io/en/latest/validation.html#
 numpydoc_validate = True

doc/source/index.rst

@@ -16,6 +16,10 @@
 =====================================================
 ``ansys-tools-path``: A tool to locate Ansys products
 =====================================================
+.. warning::
+
+   This library is deprecated and will no longer be maintained. Please consider using alternatives.
+   For more information, check the `deprecation issue <https://github.com/ansys/ansys-tools-path/issues/341>`_.
 
 How to install
 ==============

pyproject.toml

@@ -23,8 +23,7 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "platformdirs>=3.6.0",
-    "click>=8.1.3",        # for CLI interface
+    "ansys-tools-common"
 ]
 
 

src/ansys/tools/path/__init__.py

@@ -26,12 +26,19 @@
 WARNING: This is not concurrent-safe (multiple python processes might race on this data.)
 """
 
+import warnings
+
+warnings.warn(
+    "This library is deprecated and will no longer be maintained. "
+    "Functionality from this library has been migrated to ``ansys-tools-common``. "
+    "Please consider migrating to ``ansys-tools-common``. "
+    "For more information check https://github.com/ansys/ansys-tools-path/issues/341",
+    DeprecationWarning,
+)
 import importlib.metadata as importlib_metadata
 
 __version__ = importlib_metadata.version(__name__.replace(".", "-"))
-
-
-from ansys.tools.path.path import (
+from ansys.tools.common.path.path import (
     LOG,
     SETTINGS_DIR,
     SUPPORTED_ANSYS_VERSIONS,
@@ -53,10 +60,10 @@
     save_mechanical_path,
     version_from_path,
 )
-from ansys.tools.path.path import change_default_ansys_path  # deprecated
-from ansys.tools.path.path import find_ansys  # deprecated
-from ansys.tools.path.path import get_ansys_path  # deprecated
-from ansys.tools.path.path import save_ansys_path  # deprecated
+from ansys.tools.common.path.path import change_default_ansys_path  # deprecated
+from ansys.tools.common.path.path import find_ansys  # deprecated
+from ansys.tools.common.path.path import get_ansys_path  # deprecated
+from ansys.tools.common.path.path import save_ansys_path  # deprecated
 
 __all__ = [
     "LOG",

src/ansys/tools/path/applications/__init__.py

@@ -22,13 +22,17 @@
 
 """
 Application plugin for ansys-tools-path.
-
 This defines the interface of a plugin, which is implemented using a module.
 """
 
-# TODO - consider using pluggy?
+import warnings
 
+from ansys.tools.common.path.applications import *  # noqa
 
-class ApplicationPlugin:
-    def is_valid_executable_path(exe_loc: str) -> bool:
-        raise Exception("This is just a base class.")
+warnings.warn(
+    "This module is deprecated and will no longer be maintained. "
+    "Functionality from this module has been migrated to ``ansys-tools-common``. "
+    "Please consider migrating to ``ansys-tools-common``. "
+    "For more information check https://github.com/ansys/ansys-tools-path/issues/341",
+    DeprecationWarning,
+)

src/ansys/tools/path/applications/dyna.py

@@ -22,7 +22,14 @@
 
 """dyna-specific logic for ansys-tools-path."""
 
+import warnings
 
-def is_valid_executable_path(exe_loc: str) -> bool:
-    # dyna paths can be anything
-    return True
+from ansys.tools.common.path.applications.dyna import *  # noqa
+
+warnings.warn(
+    "This module is deprecated and will no longer be maintained. "
+    "Functionality from this module has been migrated to ``ansys-tools-common``. "
+    "Please consider migrating to ``ansys-tools-common``. "
+    "For more information check https://github.com/ansys/ansys-tools-path/issues/341",
+    DeprecationWarning,
+)

src/ansys/tools/path/applications/mapdl.py

@@ -1,7 +1,6 @@
 # Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
-#
 # 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
@@ -22,12 +21,14 @@
 
 """MAPDL-specific logic for ansys-tools-path."""
 
-import os
-import re
+import warnings
 
+from ansys.tools.common.path.applications.mapdl import *  # noqa
 
-def is_valid_executable_path(exe_loc: str) -> bool:
-    return (
-        os.path.isfile(exe_loc)
-        and re.search(r"ansys\d\d\d", os.path.basename(os.path.normpath(exe_loc))) is not None
-    )
+warnings.warn(
+    "This module is deprecated and will no longer be maintained. "
+    "Functionality from this module has been migrated to ``ansys-tools-common``. "
+    "Please consider migrating to ``ansys-tools-common``. "
+    "For more information check https://github.com/ansys/ansys-tools-path/issues/341",
+    DeprecationWarning,
+)