MAINT: minor updates to pre-commit and logo correction (#491)

RobPasMue · web-flow · commit e0e2b30d04f6 · 2023-04-17T14:46:13.000+02:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -9,7 +9,7 @@ updates:
       - "dependencies"
     ignore:
       - dependency-name: "grpcio"
-    assignees: 
+    assignees:
       - "pyansys-ci-bot"
 
   - package-ecosystem: "github-actions"
@@ -18,5 +18,5 @@ updates:
       interval: "daily"
     labels:
       - "maintenance"
-    assignees: 
+    assignees:
       - "pyansys-ci-bot"
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -54,7 +54,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
         python-version: ['3.8', '3.9', '3.10', '3.11']
-        should-release: 
+        should-release:
           - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
         exclude:
           - should-release: false
@@ -328,7 +328,7 @@ jobs:
     name: Fetch release artifacts
     needs: [testing-windows, testing-linux, docs]
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-    runs-on: 
+    runs-on:
       group: ansys-internal
       labels: [self-hosted, Windows, signtool]
 
@@ -337,7 +337,7 @@ jobs:
         run: |
           curl.exe -X GET -H "X-JFrog-Art-Api: ${{ secrets.ARTIFACTORY_KEY }}" ${{ secrets.ARTIFACTORY_URL }}/DockerWindows.zip --output windows-binaries.zip
           curl.exe -X GET -H "X-JFrog-Art-Api: ${{ secrets.ARTIFACTORY_KEY }}" ${{ secrets.ARTIFACTORY_URL }}/DockerLinux.zip --output linux-binaries.zip
-      
+
       - name: Upload Windows binaries as workflow artifacts
         uses: actions/upload-artifact@v3
         with:
diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml
@@ -40,7 +40,7 @@ jobs:
     # 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, 'doc') ||
         startsWith(github.event.pull_request.head.ref, 'docs')
       with:
         labels: documentation
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,15 +1,15 @@
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 23.1.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+  rev: 23.3.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
   hooks:
   - id: black
 
 - repo: https://github.com/adamchainz/blacken-docs
   rev: 1.13.0
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==23.1.0]
+    additional_dependencies: [black==23.3.0]
 
 - repo: https://github.com/pycqa/isort
   rev: 5.12.0
@@ -40,6 +40,8 @@ repos:
   hooks:
   - id: check-merge-conflict
   - id: debug-statements
+  - id: check-yaml
+  - id: trailing-whitespace
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
diff --git a/README.rst b/README.rst
@@ -179,10 +179,10 @@ Installing PyGeometry in developer mode allows
 you to modify the source and enhance it.
 
 .. note::
-   
+
     Before contributing to the project, ensure that you are thoroughly familiar
     with the `PyAnsys Developer's Guide`_.
-    
+
 To install PyGeometry in developer mode, perform these steps:
 
 #. Clone the ``pygeometry`` repository:
@@ -222,7 +222,7 @@ To install PyGeometry in developer mode, perform these steps:
 #. Install the project in editable mode:
 
    .. code:: bash
-      
+
       # Install the minimum requirements
       python -m pip install -e .
 
@@ -263,7 +263,7 @@ Testing
 
 This project takes advantage of `tox`_. This tool automate common
 development tasks (similar to Makefile), but it is oriented towards Python
-development. 
+development.
 
 Using ``tox``
 ^^^^^^^^^^^^^
@@ -279,7 +279,7 @@ The following environments commands are provided:
 - **tox -e py-coverage**: Checks for unit testing and code coverage.
 - **tox -e doc**: Checks for documentation building process.
 
- .. admonition:: pyvista-pytest plugin 
+ .. admonition:: pyvista-pytest plugin
 
    This plugin facilitates the comparison of the images produced in PyGeometry for testing the plots.
    If you are changing the images, use flag ``--reset_image_cache`` which is not recommended except
@@ -331,7 +331,7 @@ the building requirements and then executing the build module:
 
 .. code:: bash
 
-    python -m pip install -U pip 
+    python -m pip install -U pip
     python -m build
     python -m twine check dist/*
 
diff --git a/doc/make.bat b/doc/make.bat
@@ -36,7 +36,7 @@ goto end
 goto build-examples-py
 
 :clean
-rmdir /s /q %BUILDDIR% > /NUL 2>&1 
+rmdir /s /q %BUILDDIR% > /NUL 2>&1
 for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d"
 goto end
 
diff --git a/doc/source/_static/thumbnails/101_getting_started.png b/doc/source/_static/thumbnails/101_getting_started.png
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
@@ -6,7 +6,7 @@ Overall guidance on contributing to a PyAnsys library appears in the
 in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
 with it and all `How-to <https://dev.docs.pyansys.com/how-to/index.html>`_ pages
 before attempting to contribute to PyGeometry.
- 
+
 The following contribution information is specific to PyGeometry.
 
 Clone the repository
diff --git a/doc/source/examples/01_getting_started/04_modeling.mystnb b/doc/source/examples/01_getting_started/04_modeling.mystnb
@@ -255,7 +255,7 @@ More features of each of these objects will be shown in upcoming demos.
 
 Finally, it is highly recommended once you finish interacting with your modeling
 service, you close the active server session. This will allow to free resources
-wherever the service is running on. 
+wherever the service is running on.
 
 In order to close the session, do as follows.
 
diff --git a/doc/source/examples/02_sketching/dynamic_sketch_plane.mystnb b/doc/source/examples/02_sketching/dynamic_sketch_plane.mystnb
@@ -43,7 +43,7 @@ from ansys.geometry.core.sketch import Sketch
 
 ## Define a sketch profile for the PCB
 
-You can create, modify, and plot ``Sketch`` instances independent of supporting 
+You can create, modify, and plot ``Sketch`` instances independent of supporting
 Geometry service instances.
 
 Create a sketch outline of individual ``Segment`` and ``Arc`` objects with two
@@ -75,8 +75,8 @@ sketch.plot()
 
 ## Extrude multiple bodies with a single sketch
 
-Establish a server connection and use the single sketch profile to extrude 
-the board profile at multiple Z-offsets. A named selection is created from the 
+Establish a server connection and use the single sketch profile to extrude
+the board profile at multiple Z-offsets. A named selection is created from the
 resulting list of layer bodies.
 
 Note that translating the sketch plane prior to extrusion is more effective (10 server calls)
diff --git a/doc/source/examples/03_modeling/design_organization.mystnb b/doc/source/examples/03_modeling/design_organization.mystnb
@@ -17,7 +17,7 @@ The ``Design`` instance creates a design project within the remote Geometry serv
 complete all CAD modeling against.
 
 You can organize all solid and surface bodies in each design within a customizable
-component hierarchy. A component is simply an organization mechanism. 
+component hierarchy. A component is simply an organization mechanism.
 
 The top-level design node and each child-component node can have one or more bodies assigned
 and one or more components assigned.
@@ -44,7 +44,7 @@ from ansys.geometry.core.sketch import Sketch
 ## Organize design
 
 Extrude two sketches to create bodies. Assign the cylinder to the
-top-level design component. Assign the slot to the component nested 
+top-level design component. Assign the slot to the component nested
 one level beneath the top-level design component.
 
 ```{code-cell} ipython3
diff --git a/doc/source/examples/03_modeling/plate_with_hole.mystnb b/doc/source/examples/03_modeling/plate_with_hole.mystnb
@@ -29,7 +29,7 @@ The projection is at the center of the face. The default projection depth is thr
 
 Start by performing required imports.
 
-```{code-cell} ipython3 
+```{code-cell} ipython3
 import numpy as np
 from pint import Quantity
 
@@ -47,7 +47,7 @@ a box on the center, and a circle at its four corners.
 You can use a single sketch instance for multiple design operations such as extruding a body,
 projecting a profile, or imprinting curves.
 
-```{code-cell} ipython3 
+```{code-cell} ipython3
 sketch = Sketch()
 (sketch.segment(Point2D([-4, 5], unit=UNITS.m), Point2D([4, 5], unit=UNITS.m))
     .segment_to_point(Point2D([4, -5], unit=UNITS.m))
@@ -63,8 +63,8 @@ sketch = Sketch()
 
 ## Create the design by extruding the sketch
 
-Establish a server connection and use the single sketch profile to extrude 
-the base component at the Z axis. A named selection is created from the 
+Establish a server connection and use the single sketch profile to extrude
+the base component at the Z axis. A named selection is created from the
 resulting list of bodies. In only three server calls, the design extrudes
 the four segments with the desired thickness.
 
@@ -102,7 +102,7 @@ design.plot()
 
 ## Extrude from face to create body
 
-You can extrude a face profile by a given distance to create a solid body. 
+You can extrude a face profile by a given distance to create a solid body.
 There are no modifications against the body containing the source face.
 
 ```{code-cell} ipython3
diff --git a/doc/source/examples/03_modeling/tessellation_usage.mystnb b/doc/source/examples/03_modeling/tessellation_usage.mystnb
@@ -72,7 +72,7 @@ body = comp.extrude_sketch("Body", sketch=sketch_2, distance=10 * UNITS.m)
 ## Tessellation of the component as two merged bodies
 
 Tessellate the component and merge each body into a single dataset.
-This effectively combines all the faces of each individual body into a 
+This effectively combines all the faces of each individual body into a
 single dataset without separating faces.
 
 ```{code-cell} ipython3
diff --git a/doc/source/getting_started/docker.rst b/doc/source/getting_started/docker.rst
@@ -13,7 +13,7 @@ please install `Docker Engine <https://docs.docker.com/engine/install/>`_ from t
     At the moment, the Geometry service backend is only delivered as a Windows Docker container.
     As such, this container only runs on a Windows machine. Furthermore, it has also been observed
     that certain Docker Desktop versions for Windows are not properly configured for running Windows
-    Docker containers. Refer to 
+    Docker containers. Refer to
     :ref:`Running the Geometry service Windows Docker container <ref_docker_windows>` for further details.
 
 .. _ref_docker_windows:
@@ -47,7 +47,7 @@ Docker container.
 
 #. Using your GitHub credentials, download the Docker image from the `pygeometry <https://github.com/pyansys/pygeometry>`_ repository.
 
-#. If you have Docker installed, use a GitHub personal access token (PAT) with packages read permission to authorize Docker 
+#. If you have Docker installed, use a GitHub personal access token (PAT) with packages read permission to authorize Docker
    to access this repository. For more information,
    see `creating a personal access token <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token>`_.
 
@@ -59,7 +59,7 @@ Docker container.
 
 #. Authorize Docker to access the repository:
 
-.. tab-set:: 
+.. tab-set::
 
     .. tab-item:: Linux/Mac
 
@@ -117,7 +117,7 @@ Other optional environment variables are:
 
 Depending on the mechanism chosen to launch the Geometry service, you can set them as follows:
 
-.. tab-set:: 
+.. tab-set::
 
     .. tab-item:: Using PyGeometry launcher
 
@@ -161,7 +161,7 @@ Geometry service launcher
 
 The Geometry service can be launched locally in two different ways:
 
-.. tab-set:: 
+.. tab-set::
 
     .. tab-item:: Using PyGeometry launcher
 
@@ -207,7 +207,7 @@ your ``docker run`` command by changing ``<HOST-PORT>-50051``.
 If you want to change the defaults, modify environment variables and the
 ``Modeler`` function:
 
-.. tab-set:: 
+.. tab-set::
 
     .. tab-item:: Environment variables
 
diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst
@@ -3,7 +3,7 @@ Getting started
 
 PyGeometry is a Python client library for the Ansys Geometry service.
 
-To use PyGeometry, you must have a local installation of `Docker <https://docs.docker.com/engine/install/>`_. 
+To use PyGeometry, you must have a local installation of `Docker <https://docs.docker.com/engine/install/>`_.
 To start the service locally, you must be `authenticated to ghcr.io
 <https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry>`_.
 
diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst
@@ -10,7 +10,7 @@ Package dependencies
 
 PyGeometry is supported on Python version 3.8 and later. As indicated in
 `Moving to require Python 3 <https://python3statement.org/>`_, previous
-versions of Python are no longer supported. 
+versions of Python are no longer supported.
 
 PyGeometry dependencies are automatically checked when packages are installed.
 These projects are required dependencies for PyGeometry:
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -22,7 +22,7 @@ PyGeometry is a Python client library for the Ansys Geometry service.
                :outline:
                :click-parent:
 
-                  Getting started             
+                  Getting started
 
    .. grid-item-card::
             :img-top: _static/assets/index_user_guide.png
@@ -58,7 +58,7 @@ PyGeometry is a Python client library for the Ansys Geometry service.
                :outline:
                :click-parent:
 
-                  API 
+                  API
 
    .. grid-item-card::
             :img-top: _static/assets/index_contribute.png
@@ -78,11 +78,11 @@ PyGeometry is a Python client library for the Ansys Geometry service.
 
                   Contribute
 
-.. grid:: 
+.. grid::
 
    .. grid-item-card::
             :img-top: _static/assets/index_examples.png
-      
+
             Examples
             ^^^^^^^^
             The examples demonstrate the behavior and usage of PyGeometry.
diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst
@@ -34,7 +34,7 @@ Start a Geometry server instance
 
 The :class:`Modeler() <ansys.geometry.core.modeler()>` class
 within the ``ansys-geometry-core`` library creates an instance of
-the Geometry service. By default ``Modeler`` connects to ``127.0.0.1`` 
+the Geometry service. By default ``Modeler`` connects to ``127.0.0.1``
 (``'localhost'``) on port ``50051``. You can change this by modifying
 the ``host`` and ``port`` parameters of ``Modeler``, but note that you
 have to also modify this in your ``docker run`` command by changing ``<HOST-PORT>-50051``.
@@ -49,7 +49,7 @@ You start the Geometry service with:
 Create geometry model
 ---------------------
 
-Once the Geometry service is active , you can start creating the geometry model 
+Once the Geometry service is active , you can start creating the geometry model
 by initializing the :ref:`Sketch <ref_sketch>` class and using the
 :ref:`Primitives <ref_primitives>` math subpackage for PyGeometry.
 
diff --git a/doc/source/user_guide/primitives.rst b/doc/source/user_guide/primitives.rst
@@ -10,17 +10,17 @@ manipulate physical quantities.
 
 This table shows PyGeometry base values:
 
-+----------------------------+---------+ 
++----------------------------+---------+
 | Name                       | value   |
 +============================+=========+
 | LENGTH_ACCURACY            | 1e-8    |
-+----------------------------+---------+  
++----------------------------+---------+
 | ANGLE_ACCURACY             | 1e-6    |
-+----------------------------+---------+ 
++----------------------------+---------+
 | DEFAULT_UNITS.LENGTH       | meter   |
-+----------------------------+---------+ 
++----------------------------+---------+
 | DEFAULT_UNITS.ANGLE        | radian  |
-+----------------------------+---------+ 
++----------------------------+---------+
 
 You use these PyGeometry classes to define accuracy and measurements:
 
@@ -30,7 +30,7 @@ You use these PyGeometry classes to define accuracy and measurements:
 Plane concept
 -------------
 
-The :class:`Plane() <ansys.geometry.core.math.plane>` class provides primitive representation of a 2D plane in 3D space. 
+The :class:`Plane() <ansys.geometry.core.math.plane>` class provides primitive representation of a 2D plane in 3D space.
 It has an origin and a coordinate system.
 Sketched shapes are always defined relative to a plane.
 The default working plane is XY with ``(0,0)`` as the origin.
diff --git a/doc/source/user_guide/shapes.rst b/doc/source/user_guide/shapes.rst
diff --git a/docker/README.rst b/docker/README.rst
