Merge branch 'main' into release/0.6

Author: RobPasMue

.flake8

@@ -6,46 +6,17 @@ ci:
 exclude: "tests/integration/files"
 repos:
 
-- repo: https://github.com/psf/black
-  rev: 24.4.2  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.4.9
   hooks:
-  - id: black
-
-- repo: https://github.com/adamchainz/blacken-docs
-  rev: 1.16.0
-  hooks:
-  - id: blacken-docs
-    additional_dependencies: [black==24.4.2]
-
-- repo: https://github.com/pycqa/isort
-  rev: 5.13.2
-  hooks:
-  - id: isort
-
-- repo: https://github.com/PyCQA/flake8
-  rev: 7.1.0
-  hooks:
-  - id: flake8
-
-- repo: https://github.com/PyCQA/docformatter
-  rev: v1.7.5
-  hooks:
-  - id: docformatter
-    additional_dependencies: [tomli]
+    - id: ruff
 
 - repo: https://github.com/codespell-project/codespell
   rev: v2.3.0
   hooks:
   - id: codespell
     args: ["--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt", "-w"]
 
-- repo: https://github.com/pycqa/pydocstyle
-  rev: 6.3.0
-  hooks:
-  - id: pydocstyle
-    additional_dependencies: [tomli]
-    exclude: "tests/"
-
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.6.0
   hooks:
@@ -55,7 +26,7 @@ repos:
   - id: trailing-whitespace
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.3.1
+  rev: v0.3.2
   hooks:
     - id: add-license-headers
       files: '(src|examples|tests|docker)/.*\.(py)|\.(proto)'

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 PyAnsys Geometry
 ================
-|pyansys| |python| |MIT| |black|
+|pyansys| |python| |MIT| |ruff|
 |codecov| |GH-CI| |pre-commit|
 |pypi| |pypi-downloads| |conda| |conda-downloads|
 
@@ -40,9 +40,9 @@ PyAnsys Geometry
    :target: https://opensource.org/blog/license/mit
    :alt: MIT
 
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
-   :target: https://github.com/psf/black
-   :alt: Black
+.. |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
 
 .. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyansys-geometry/main.svg
    :target: https://results.pre-commit.ci/latest/github/ansys/pyansys-geometry/main

README.rst

@@ -0,0 +1 @@
+chore: update CHANGELOG for v0.6.3

doc/changelog.d/1273.changed.md

@@ -0,0 +1 @@
+feat: using ruff as the main linter/formatter

doc/changelog.d/1274.added.md

@@ -0,0 +1 @@
+fix: backticks breaking doc build after ruff linter

doc/changelog.d/1275.fixed.md

@@ -0,0 +1 @@
+chore: bump pre-commit-hook version

doc/changelog.d/1276.changed.md

@@ -0,0 +1 @@
+build: bump pint from 0.24 to 0.24.1

doc/changelog.d/1277.dependencies.md

@@ -54,7 +54,7 @@ def get_wheelhouse_assets_dictionary():
                 content = response.content
                 break
             else:
-                print(f"Failed to retrieve the latest release. Retrying...")
+                print("Failed to retrieve the latest release. Retrying...")
                 time.sleep(2)
 
         if content is None:
@@ -83,8 +83,7 @@ def get_wheelhouse_assets_dictionary():
 
 
 def intersphinx_pyansys_geometry(switcher_version: str):
-    """
-    Auxiliary method to build the intersphinx mapping for PyAnsys Geometry.
+    """Auxiliary method to build the intersphinx mapping for PyAnsys Geometry.
 
     Notes
     -----
@@ -383,8 +382,7 @@ def intersphinx_pyansys_geometry(switcher_version: str):
 
 
 def convert_notebooks_to_scripts(app: sphinx.application.Sphinx, exception):
-    """
-    Convert notebooks to scripts.
+    """Convert notebooks to scripts.
 
     Parameters
     ----------
@@ -431,15 +429,14 @@ def convert_notebooks_to_scripts(app: sphinx.application.Sphinx, exception):
 
 
 def setup(app: sphinx.application.Sphinx):
-    """
-    Run different hook functions during the documentation build.
+    """Run different hook functions during the documentation build.
 
     Parameters
     ----------
     app : sphinx.application.Sphinx
         Sphinx instance containing all the configuration for the documentation build.
     """
-    logger.info(f"Configuring Sphinx hooks...")
+    logger.info("Configuring Sphinx hooks...")
     if BUILD_EXAMPLES:
         # Run at the end of the build process
         logger.info("Connecting build-finished hook for converting notebooks to scripts...")

doc/source/conf.py

@@ -71,19 +71,14 @@ This way, it's not possible for you to push code that fails the style checks::
 
   $ pre-commit install
   $ git commit -am "added my cool feature"
-  black....................................................................Passed
-  blacken-docs.............................................................Passed
-  isort....................................................................Passed
-  flake8...................................................................Passed
-  docformatter.............................................................Passed
+  ruff.....................................................................Passed
   codespell................................................................Passed
-  pydocstyle...............................................................Passed
   check for merge conflicts................................................Passed
   debug statements (python)................................................Passed
   check yaml...............................................................Passed
   trim trailing whitespace.................................................Passed
-  Add License Headers......................................................Passed
   Validate GitHub Workflows................................................Passed
+  check pre-commit.ci config...............................................Passed
 
 Build the documentation
 -----------------------