feat: tech review

.github/dependabot.yml

@@ -3,14 +3,14 @@ updates:
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
     labels:
       - "maintenance"
       - "dependencies"
 
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
     labels:
       - "maintenance"

.github/workflows/ci_cd.yml

@@ -1,6 +1,7 @@
 name: GitHub CI
 on:
   pull_request:
+  merge_group:
   workflow_dispatch:
   push:
     tags:
@@ -12,10 +13,8 @@ env:
   MAIN_PYTHON_VERSION: "3.10"
   DOCUMENTATION_CNAME: "additive.docs.pyansys.com"
   LIBRARY_NAME: "ansys-additive"
-  LIBRARY_NAMESPACE: "ansys.additive"
   ANSYS_PRODUCT_IMAGE: "ghcr.io/ansys/additive:latest"
   ANSYS_PRODUCT_CONTAINER: "ansys-additive-container"
-
   PYANSYS_PYPI_PRIVATE_PAT: ${{ secrets.PYANSYS_PYPI_PRIVATE_PAT }}
   PIP_INDEX_URL: "https://${{ secrets.PYANSYS_PYPI_PRIVATE_PAT }}@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/"
 
@@ -35,24 +34,25 @@ jobs:
     name: "Running documentation style checks"
     runs-on: ubuntu-latest
     steps:
-      - name: "Checkout code"
-        uses: actions/checkout@v3
-
       - name: "Running documentation style checks"
         uses: ansys/actions/doc-style@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          checkout: false
 
   smoke-tests:
     name: "Build wheelhouse for Python versions"
     runs-on: ${{ matrix.os }}
     needs: [code-style]
     strategy:
+      fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest]
-        # python-version: ["3.8", "3.9", "3.10", "3.11"]
-        python-version: ["3.10"]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        should-release:
+          - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
+        exclude:
+          - should-release: false
+            os: macos-latest
     steps:
       - name: "Build a wheelhouse of the Python library"
         uses: ansys/actions/build-wheelhouse@v4
@@ -73,8 +73,6 @@ jobs:
     steps:
       - name: "Run pytest"
         uses: ansys/actions/tests-pytest@v4
-        with:
-          pytest-extra-args: "--cov=${{ env.LIBRARY_NAMESPACE }} --cov-report=term --cov-report=html:.cov/html"
 
   doc-build:
     name: "Building library documentation"
@@ -115,6 +113,7 @@ jobs:
         uses: ansys/actions/doc-build@v4
         with:
           checkout: false
+          sphinxopts: "-j auto"
         env:
           GENERATING_DOCS: 1
           ANSYS_ADDITIVE_ADDRESS: "localhost:50052"
@@ -125,6 +124,7 @@ jobs:
         uses: ansys/actions/doc-build@v4
         with:
           checkout: false
+          sphinxopts: "-j auto"
         env:
           GENERATING_DOCS: 1
           ANSYS_ADDITIVE_ADDRESS: "localhost:50052"
@@ -142,21 +142,9 @@ jobs:
           name: docker-logs.txt
           path: docker-logs.txt
 
-  doc-deploy-dev:
-    name: "Deploy developers documentation"
-    runs-on: ubuntu-latest
-    needs: doc-build
-    if: github.event_name == 'push'
-    steps:
-      - name: "Deploy the latest documentation"
-        uses: ansys/actions/doc-deploy-dev@v4
-        with:
-          cname: ${{ env.DOCUMENTATION_CNAME }}
-          token: ${{ secrets.GITHUB_TOKEN }}
-
   build-library:
     name: "Build library artifacts"
-    needs: [tests, doc-deploy-dev]
+    needs: [tests, doc-build]
     runs-on: ubuntu-latest
     steps:
       - name: "Build library source and wheel artifacts"
@@ -183,6 +171,18 @@ jobs:
         with:
           library-name: ${{ env.LIBRARY_NAME }}
 
+  upload_dev_docs:
+    name: "Deploy developers documentation"
+    runs-on: ubuntu-latest
+    needs: [build-library]
+    if: github.event_name == 'push'
+    steps:
+      - name: "Deploy the latest documentation"
+        uses: ansys/actions/doc-deploy-dev@v4
+        with:
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
   upload_docs_release:
     name: "Upload release documentation"
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')

.gitignore

@@ -79,6 +79,7 @@ instance/
 # Sphinx documentation
 doc/source/examples
 _autosummary/
+doc/_build
 
 # PyBuilder
 .pybuilder/

.pre-commit-config.yaml

@@ -1,23 +1,36 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 22.8.0
+    rev: 23.7.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
     hooks:
       - id: black
 
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.16.0
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==23.7.0]
+
   - repo: https://github.com/pycqa/isort
     rev: 5.12.0
     hooks:
       - id: isort
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 5.0.4
+    rev: 6.1.0
     hooks:
       - id: flake8
 
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.5
+    hooks:
+      - id: docformatter
+        additional_dependencies: [tomli]
+
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.1
+    rev: v2.2.5
     hooks:
       - id: codespell
+        args: ["--ignore-words", "doc/styles/Vocab/ANSYS/accept.txt"]
         exclude_types: ["jupyter"]
 
   # To be activated after quick dev cycles
@@ -30,13 +43,15 @@ repos:
   #     exclude: "tests/"
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     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
-    rev: 0.22.0
+    rev: 0.24.1
     hooks:
       - id: check-github-workflows

README.rst

@@ -3,6 +3,9 @@
 ##########
 PyAdditive
 ##########
+
+.. readme_start
+
 |pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|
 
 .. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
@@ -34,7 +37,7 @@ PyAdditive
    :alt: Black
 
 
-A Python client library for the Ansys additive service.
+A Python client library for the Ansys Additive service.
 
 Installation
 ============
@@ -59,13 +62,14 @@ Basic Usage
 .. code:: python
 
    import ansys.additive as pyadditive
+
    additive = pyadditive.Additive()
 
    input = pyadditive.SingleBeadInput(
-      machine=pyadditive.AdditiveMachine(),
-      material=additive.get_material("Ti64"),
-      id="bead1",
-      bead_length=0.001, # meters
+       machine=pyadditive.AdditiveMachine(),
+       material=additive.get_material("Ti64"),
+       id="bead1",
+       bead_length=0.001,  # meters
    )
 
    summary = additive.simulate(input)

doc/make.bat

@@ -33,6 +33,7 @@ goto end
 
 :clean
 rmdir /s /q %BUILDDIR% > /NUL 2>&1
+rmdir /s /q %SOURCEDIR%\examples > /NUL 2>&1
 for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d"
 goto end
 

doc/source/_autoapi_templates/index.rst

@@ -0,0 +1,15 @@
+API reference
+=============
+
+This section provides descriptions of PyAdditive subpackages, submodules, classes,
+methods, and attributes. Use the search feature or click links to view API documentation.
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 2
+
+   {% for page in pages %}
+   {% if (page.top_level_object or page.name.split('.') | length == 2) and page.display %}
+   {{ page.include_path }}
+   {% endif %}
+   {% endfor %}